com.arsdigita.cms
Class Article

java.lang.Object
  extended bycom.arsdigita.domain.DomainObject
      extended bycom.arsdigita.domain.ObservableDomainObject
          extended bycom.arsdigita.kernel.ACSObject
              extended bycom.arsdigita.versioning.VersionedACSObject
                  extended bycom.arsdigita.cms.ContentItem
                      extended bycom.arsdigita.cms.ContentPage
                          extended bycom.arsdigita.cms.TextPage
                              extended bycom.arsdigita.cms.Article
All Implemented Interfaces:
com.arsdigita.auditing.Audited, CustomCopy

public class Article
extends TextPage

A class that represents an Article

Version:
$Revision: #27 $ $Date: 2004/04/07 $
Author:
Jack Chung (flattop@arsdigita.com)

Field Summary
static String BASE_DATA_OBJECT_TYPE
           
protected static String IMAGES
           
static String versionId
           
 
Fields inherited from class com.arsdigita.cms.TextPage
SUMMARY_SIZE, TEXT_ASSET
 
Fields inherited from class com.arsdigita.cms.ContentPage
LAUNCH_DATE, PAGES_IN_CATEGORY, PAGES_IN_FOLDER, QUERY_CATEGORY_ID, QUERY_PAGE, QUERY_ROOT_ID, QUERY_TYPE, SUMMARY, TITLE
 
Fields inherited from class com.arsdigita.cms.ContentItem
ANCESTORS, AUDITING, CHILDREN, CONTENT_SECTION, CONTENT_TYPE, DRAFT, DRAFT_VERSION, LANGUAGE, LIVE, NAME, PARENT, PENDING, VERSION, VERSIONS
 
Fields inherited from class com.arsdigita.versioning.VersionedACSObject
IS_DELETED, MASTER
 
Fields inherited from class com.arsdigita.kernel.ACSObject
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE
 
Constructor Summary
Article()
          Default constructor.
Article(BigDecimal id)
          Constructor.
Article(com.arsdigita.persistence.DataObject obj)
           
Article(com.arsdigita.persistence.OID oid)
          Constructor.
Article(String type)
           
 
Method Summary
 boolean addImage(ImageAsset image, String caption)
          Add an image to this article.
 void clearImages()
          Unassociate all images from this article
 String getBaseDataObjectType()
           
 String getCaption(ImageAsset image)
          Deprecated. Do not use this method, it will always return the first available caption regardless of what image is in use. Use ArticleImageAssnCollection.getCaption() or ArticleImageAssociation.getCaption().
 ImageAssetCollection getImages()
          Get the images for this article
protected  void propagateMaster(com.arsdigita.versioning.VersionedACSObject master)
           
 boolean removeImage(ImageAsset image)
          Remove a image from this article.
 
Methods inherited from class com.arsdigita.cms.TextPage
getSearchSummary, getTextAsset, setTextAsset
 
Methods inherited from class com.arsdigita.cms.ContentPage
getContentBundle, getDisplayName, getLaunchDate, getPagesInSectionQuery, getPagesInSectionQuery, getPagesInSectionQuery, getPagesInSectionQuery, getTitle, setLaunchDate, setName, setPagesQueryParameters, setPagesQueryParameters, setTitle
 
Methods inherited from class com.arsdigita.cms.ContentItem
addCategory, addPendingVersion, afterSave, assertDraft, assertLive, assertMaster, assertPending, beforeDelete, beforeSave, canPublishToFS, copy, copy, copyProperty, copyProperty, copyServices, copyServicesFrom, createLiveVersion, createPendingVersion, get, getCategories, getCategoryCollection, getChildren, getContentSection, getContentType, getCreationDate, getCreationIP, getCreationUser, getDraftVersion, getLanguage, getLastModifiedDate, getLastModifiedIP, getLastModifiedUser, getLifecycle, getLiveVersion, getLocale, getName, getParent, getPath, getPathInfo, getPathInfo, getPathNoJsp, getPendingVersions, getPublicVersion, getVersion, getWorkingVersion, initialize, isDraftVersion, isLive, isLiveVersion, isPendingVersion, isPublished, makeCopy, promotePendingVersion, publish, publishToFS, removeCategory, removeLifecycle, removePendingVersion, set, setContentSection, setContentType, setDefaultCategory, setLanguage, setLifecycle, setLive, setLiveVersion, setParent, setVersion, setVersionRecursively, unpublish, unpublishFromFS
 
Methods inherited from class com.arsdigita.versioning.VersionedACSObject
applyTag, applyUniqueTag, autoPropagateMaster, getMaster, getRolledBackTo, getTransactions, getTransactions, isMaster, isRolledBack, isSubtype, permanentlyDelete, recordAttributeChange, rollBackTo, rollBackTo, rollForward, save, setMaster, trackChanges
 
Methods inherited from class com.arsdigita.kernel.ACSObject
assertPrivilege, checkPrivilege, doCreateCheck, doWriteCheck, getContainer, getDefaultDomainClass, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, 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, clear, delete, disconnect, equals, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values

BASE_DATA_OBJECT_TYPE

public static final String BASE_DATA_OBJECT_TYPE
See Also:
Constant Field Values

IMAGES

protected static final String IMAGES
See Also:
Constant Field Values
Constructor Detail

Article

public Article()
Default constructor. This creates a new article.


Article

public Article(com.arsdigita.persistence.OID oid)
        throws com.arsdigita.domain.DataObjectNotFoundException
Constructor. The contained DataObject is retrieved from the persistent storage mechanism with an OID specified by oid.

Parameters:
oid - The OID for the retrieved DataObject.

Article

public Article(String type)

Article

public Article(BigDecimal id)
        throws com.arsdigita.domain.DataObjectNotFoundException
Constructor. The contained DataObject is retrieved from the persistent storage mechanism with an OID specified by id and Article.BASE_DATA_OBJECT_TYPE.

Parameters:
id - The id for the retrieved DataObject.

Article

public Article(com.arsdigita.persistence.DataObject obj)
Method Detail

getBaseDataObjectType

public String getBaseDataObjectType()
Overrides:
getBaseDataObjectType in class TextPage
Returns:
the base PDL object type for this item. Child classes should override this method to return the correct value

addImage

public boolean addImage(ImageAsset image,
                        String caption)
Add an image to this article. If the image is already added to the article, the caption will be updated.

Parameters:
image - the image to add
caption - the caption for the image
Returns:
true if image is added and false if caption is updated

getCaption

public String getCaption(ImageAsset image)
Deprecated. Do not use this method, it will always return the first available caption regardless of what image is in use. Use ArticleImageAssnCollection.getCaption() or ArticleImageAssociation.getCaption().

Get the caption of the image

Returns:
the caption, or null if the image is not associated to this article

removeImage

public boolean removeImage(ImageAsset image)
Remove a image from this article.

Returns:
true is the image is removed, false otherwise.

getImages

public ImageAssetCollection getImages()
Get the images for this article


clearImages

public void clearImages()
Unassociate all images from this article


propagateMaster

protected void propagateMaster(com.arsdigita.versioning.VersionedACSObject master)
Overrides:
propagateMaster in class TextPage


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2352 UTC