|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Edition
An Edition
object represents an Edition in the WCM
repository. An edition is a "named" collection of the versions of a subtree taken at a
particular point in time.
Method Summary | |
---|---|
java.lang.String |
getCreator()
Returns the name of creator of this Document object as a string. |
java.lang.String |
getDescription(java.util.Locale paramLocale)
Editions do not currently have a description, so this will always return null |
Identity<Edition> |
getIdentity()
Returns the unique Id of the Edition |
ListModel<java.util.Locale> |
getLocales()
Returns the Locale used when creating the Edition . |
java.lang.String |
getTitle(java.util.Locale paramLocale)
Gets the name of this Edition in the specified Locale, or null if a name is not available in that locale |
ResultIterator<Version> |
getVersions()
Retrieve Versions the make up this Edition |
PageIterator<Version> |
getVersions(int resultsPerPage,
int firstPage)
Retrieve Versions the make up this Edition |
Methods inherited from interface com.ibm.workplace.wcm.api.WCMApiObject |
---|
getName |
Methods inherited from interface com.ibm.portal.TimeStamped |
---|
getCreated, getLastModified |
Method Detail |
---|
Identity<Edition> getIdentity()
Edition
java.lang.String getTitle(java.util.Locale paramLocale)
null if a name is not available in that locale
- Specified by:
getTitle
in interface Localized
- Parameters:
locale
- of the name to return
- Returns:
- name of this Edition
java.lang.String getDescription(java.util.Locale paramLocale)
null
getDescription
in interface Localized
locale
- of the name to return
null
ListModel<java.util.Locale> getLocales()
Edition
. Currently only a single Locale will be returned.
getLocales
in interface Localized
java.lang.String getCreator()
Document
object as a string. The string is either the
user's common name or distinguished name, depending on the setting
on the Workspace. See Workspace.isDistinguishedNamesUsed()
.
ResultIterator<Version> getVersions() throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.VersioningException
com.ibm.workplace.wcm.api.exceptions.VersioningException
- if an error occurred retrieving a Version
com.ibm.workplace.wcm.api.exceptions.EditionException
- if an error occurred retrieving a Version
PageIterator<Version> getVersions(int resultsPerPage, int firstPage) throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.VersioningException
resultsPerPage
- how many version to per pagefirstPage
- the first page of the returned versions
com.ibm.workplace.wcm.api.exceptions.VersioningException
- if an error occurred retrieving a Version
com.ibm.workplace.wcm.api.exceptions.EditionException
- if an error occurred retrieving a Version
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |