curam.advisor.impl

Interface Link

All Superinterfaces:

curam.util.persistence.Entity<java.lang.Long>, curam.util.persistence.Insertable, curam.util.persistence.OptimisticLockable, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.Removable, curam.util.persistence.StandardEntity

@AccessLevel(value=EXTERNAL)
public interface Link
extends curam.util.persistence.StandardEntity, curam.util.persistence.Insertable, curam.util.persistence.OptimisticLockModifiable, curam.util.persistence.Removable

Link contains details of where the advice should link to. This class has been marked as non-implementable. Public methods on the class are callable, however in order to avoid future upgrade impact this class must NOT be extended or implemented as new operations may be added over time.

Method Summary

Modifier and Type	Method and Description
Image	getImage() Returns an image for this link.
java.lang.String	getName() Retrieves the name of this link.
java.lang.String	getTarget() Retrieves the link URL.
boolean	isExternal() Retrieves if the link is to an external destination.
boolean	isModal() Retrieves if the link is modal.
void	setExternal(boolean value) Sets if the link is to an external site or not.
void	setModal(boolean value) Sets if the link should open as a modal.
void	setName(java.lang.String name) Sets an optional name for this link.
void	setTarget(java.lang.String value) Sets the target of the link.

Methods inherited from interface curam.util.persistence.Entity

getContextContainer, getID, getPersistenceEventDispatcher

Methods inherited from interface curam.util.persistence.Insertable

insert

Methods inherited from interface curam.util.persistence.OptimisticLockModifiable

modify

Methods inherited from interface curam.util.persistence.OptimisticLockable

getVersionNo

Methods inherited from interface curam.util.persistence.Removable

remove

Method Detail

getTarget

java.lang.String getTarget()

Retrieves the link URL.

Returns:

The link URL.

setModal

void setModal(boolean value)

Sets if the link should open as a modal.

Parameters:

value - true if the link should open as a modal.

isModal

boolean isModal()

Retrieves if the link is modal.

Returns:

true, if this link is modal, false otherwise.

setExternal

void setExternal(boolean value)

Sets if the link is to an external site or not.

Parameters:

value - the external value.

isExternal

boolean isExternal()

Retrieves if the link is to an external destination.

Returns:

true, if this link is to an external destination, false otherwise.

setTarget

void setTarget(java.lang.String value)

Sets the target of the link.

Parameters:

value - the link target

setName

void setName(java.lang.String name)

Sets an optional name for this link. The name can be used as a reference to differentiate one link from another in a set of links.

Parameters:

name - The name of the link.

getName

java.lang.String getName()

Retrieves the name of this link.

Returns:

The name of the link, or null if none has been specified.

getImage

Image getImage()

Returns an image for this link.

Returns:

an image or null if no image specified for this link.