|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.domain.DomainObject
com.arsdigita.domain.ObservableDomainObject
com.arsdigita.kernel.ACSObject
com.arsdigita.cms.contenttypes.Link
This content type represents a Link content type for linking ContentItems and external links.
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
Data object type for this domain object |
static String |
DESCRIPTION
PDL property "description" |
static String |
EXTERNAL_LINK
Values for TARGET_TYPE |
static String |
INTERNAL_LINK
|
static String |
ORDER
PDL property "order" |
static String |
TARGET_ITEM
PDL property "targetItem" |
static String |
TARGET_TYPE
PDL property targetType |
static String |
TARGET_URI
PDL property "targetURI" |
static String |
TARGET_WINDOW
PDL property "targetWindow" |
static String |
TITLE
PDL properties cms_links.title |
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE, versionId |
Constructor Summary | |
Link()
Default constructor. |
|
Link(BigDecimal id)
Constructor. |
|
Link(com.arsdigita.persistence.DataObject obj)
Constructor. |
|
Link(com.arsdigita.persistence.OID id)
Constructor. |
|
Link(String type)
Constructor. |
Method Summary | |
protected void |
alphabetize()
This method is only used for setting initial sort keys for links which exist without them. |
String |
getDescription()
Returns the description for this Link |
String |
getInternalOrExternalURI(com.arsdigita.bebop.PageState state)
Returns the link URI as a String whether it is
internal or external. |
Integer |
getOrder()
Returns the link order for this Link |
static com.arsdigita.persistence.DataCollection |
getReferringLinks(ContentItem item)
Returns a DataCollection of links which refer to the given item. |
protected com.arsdigita.persistence.DataOperation |
getSwapOperation(String operationName)
Given a data operation name, returns the DataOperation for use in swapKeys. |
protected com.arsdigita.persistence.DataQuery |
getSwapQuery(String queryName)
Given a dataquery name, returns the (possibly filtered) DataQuery for use in swapKeys. |
ContentItem |
getTargetItem()
Returns the target ContentItem of this Link |
String |
getTargetType()
Returns the target type of this Link |
String |
getTargetURI()
Returns the target URI of this Link |
String |
getTargetWindow()
Returns the target Window of this Link |
String |
getTitle()
Returns the title of this Link |
void |
setDescription(String description)
sets the description for this Link |
void |
setOrder(int order)
Sets the link order for this Link |
void |
setOrder(Integer order)
Sets the link order for this Link |
void |
setTargetItem(ContentItem item)
Sets the target ContentItem of this Link |
void |
setTargetType(String type)
Sets the Target Type for this Link |
void |
setTargetURI(String uri)
Sets the target URI of this Link |
void |
setTargetWindow(String window)
Sets the target Window of this Link |
void |
setTitle(String title)
Sets the title of this Link |
protected void |
swapKeys(boolean swapNext,
String queryName,
String operationName)
This swaps the sort keys. |
void |
swapWithNext()
no arg swapWithNext is not implemented for the base Link class. |
void |
swapWithNext(String queryName,
String operationName)
Swaps this Link with the next Link according to the specified ORDER attribute. |
void |
swapWithPrevious()
no arg swapWithPrevious is not implemented for the base Link class. |
void |
swapWithPrevious(String queryName,
String operationName)
Swaps this Link with the previous Link according to the specified ORDER attribute. |
Methods inherited from class com.arsdigita.kernel.ACSObject |
assertPrivilege, beforeSave, checkPrivilege, doCreateCheck, doWriteCheck, getBaseDataObjectType, getContainer, getDefaultDomainClass, getDisplayName, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, initialize, isContainerModified, setID, setID |
Methods inherited from class com.arsdigita.domain.ObservableDomainObject |
addObserver, getObservers |
Methods inherited from class com.arsdigita.domain.DomainObject |
add, add, addToAssociation, afterDelete, afterSave, beforeDelete, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String TITLE
public static final String TARGET_TYPE
public static final String EXTERNAL_LINK
public static final String INTERNAL_LINK
public static final String TARGET_URI
public static final String TARGET_ITEM
public static final String TARGET_WINDOW
public static final String DESCRIPTION
public static final String ORDER
public static final String BASE_DATA_OBJECT_TYPE
Constructor Detail |
public Link()
public Link(BigDecimal id) throws com.arsdigita.domain.DataObjectNotFoundException
DataObject
is retrieved
from the persistent storage mechanism with an OID
specified by id
and Link.BASE_DATA_OBJECT_TYPE
.
id
- The id
for the retrieved
DataObject
public Link(com.arsdigita.persistence.OID id) throws com.arsdigita.domain.DataObjectNotFoundException
DataObject
is retrieved
from the persistent storage mechanism with an OID
specified by oid
.
public Link(com.arsdigita.persistence.DataObject obj)
DataObject
argument.
obj
- The DataObject
with which to create or
load a content itempublic Link(String type)
Link
using the given data
object type.
type
- The String
data object type of the
item to createMethod Detail |
public String getTitle()
Link
public void setTitle(String title)
Link
title
- The Link titlepublic String getTargetType()
Link
public void setTargetType(String type)
type
- must be either Link.EXTERNAL_LINK or
Link.INTERNAL_LINKpublic String getTargetURI()
Link
public void setTargetURI(String uri)
Link
uri
- The Target URIpublic ContentItem getTargetItem()
Link
public void setTargetItem(ContentItem item)
Link
public String getTargetWindow()
Link
public void setTargetWindow(String window)
Link
window
- The Target Windowpublic String getDescription()
Link
public void setDescription(String description)
Link
description
- the descriptionpublic Integer getOrder()
Link
public void setOrder(Integer order)
Link
order
- the link orderpublic void setOrder(int order)
Link
order
- the link orderpublic String getInternalOrExternalURI(com.arsdigita.bebop.PageState state)
String
whether it is
internal or external. Returns the empty string if no target
item exists.
state
- current PageState
public static com.arsdigita.persistence.DataCollection getReferringLinks(ContentItem item)
item
- The target Item to return links for
public void swapWithNext()
UnsupportedOperationException
public void swapWithPrevious()
UnsupportedOperationException
public void swapWithNext(String queryName, String operationName)
queryName
- name of the DataQuery to useoperationName
- name of the DataOperation to usepublic void swapWithPrevious(String queryName, String operationName)
queryName
- name of the DataQuery to useoperationName
- name of the DataOperation to useprotected com.arsdigita.persistence.DataQuery getSwapQuery(String queryName)
queryName
- name of the DataQuery to use
protected com.arsdigita.persistence.DataOperation getSwapOperation(String operationName)
operationName
- name of the DataOperation to use
protected void swapKeys(boolean swapNext, String queryName, String operationName)
swapNext
- This indicates if we are swapping with the next
or the previousqueryName
- This is used to find the key with which to swapprotected void alphabetize()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |