com.dotmarketing.business
Interface Versionable

All Known Implementing Classes:
Campaign, Category, Click, Communication, Container, Contentlet, Contentlet, ContentletAndBinary, Event, Field, File, FileAsset, FileAssetMap, FileMap, FileUpload, Folder, Host, HostWrapper, HTMLPage, Inode, Link, MailingList, MP3File, Recipient, Relationship, Report, ReportParameter, Structure, Template, TemplateWrapper, UserComment, UserFilter, UserProxy, VirtualLink, WebAsset, WorkflowMessage

public interface Versionable


Method Summary
 java.lang.String getInode()
          gets the inode (specific version id) of the versionable
 java.util.Date getModDate()
          returns the timestamp of when the last modification was made
 java.lang.String getModUser()
          returns user who last modified the version
 java.lang.String getTitle()
          returns the title of the specific asset
 java.lang.String getVersionId()
          The VersionId is the identifier of the versionable web asset every version of the particular webasset will share the same versionId/Identifier
 java.lang.String getVersionType()
          this returns the string "type" (the db table) of the versionable web asset.
 boolean isArchived()
          returns if the asset is archived or not
 boolean isLive()
          returns if the asset is live or not
 boolean isLocked()
          returns if the asset is locked or not
 boolean isWorking()
          returns if the asset is working or not
 void setVersionId(java.lang.String versionId)
          sets the versionId (identifier) of the asset
 

Method Detail

getVersionId

java.lang.String getVersionId()
The VersionId is the identifier of the versionable web asset every version of the particular webasset will share the same versionId/Identifier

Returns:

setVersionId

void setVersionId(java.lang.String versionId)
sets the versionId (identifier) of the asset

Parameters:
versionId -

getVersionType

java.lang.String getVersionType()
this returns the string "type" (the db table) of the versionable web asset. Contentlet will return 'Contentlet' Folder will return folder HTMLPage will return htmlpage Template will return template File will return file_asset Link will return links Container will return containers

Returns:

getInode

java.lang.String getInode()
gets the inode (specific version id) of the versionable

Returns:

isArchived

boolean isArchived()
                   throws DotStateException,
                          DotDataException,
                          DotSecurityException
returns if the asset is archived or not

Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

isWorking

boolean isWorking()
                  throws DotStateException,
                         DotDataException,
                         DotSecurityException
returns if the asset is working or not

Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

isLive

boolean isLive()
               throws DotStateException,
                      DotDataException,
                      DotSecurityException
returns if the asset is live or not

Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getTitle

java.lang.String getTitle()
                          throws DotStateException,
                                 DotDataException,
                                 DotSecurityException
returns the title of the specific asset

Returns:
Throws:
DotStateException
DotDataException
DotSecurityException

getModUser

java.lang.String getModUser()
returns user who last modified the version

Returns:

getModDate

java.util.Date getModDate()
returns the timestamp of when the last modification was made

Returns:

isLocked

boolean isLocked()
                 throws DotStateException,
                        DotDataException,
                        DotSecurityException
returns if the asset is locked or not

Returns:
Throws:
DotStateException
DotDataException
DotSecurityException


Copyright © 2013 dotCMS Inc. All Rights Reserved.