|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EditionService
EditionsService enables access to the WCM Editions API
This service is used to manage Edition
within the WCM repository. With this service one can create, delete, and locate existing Editions.
The service can be obtained via one of the home interfaces listed below.
EditionServiceHome
,
EditionServiceProvider
Method Summary | |
---|---|
EditionDelta |
compare(Edition start,
Edition end)
Compare the two Editions and return a set of differences. |
long |
count(EditionQuery query)
Count the query result without retrieving the actual editions. |
Edition |
create(java.lang.String name,
java.util.Locale localeOfName)
Create a new Edition. |
EditionQuery |
createQuery()
Creates a empty query that will inherit the default options. |
void |
delete(Edition edition)
Deletes the given Edition |
boolean |
existsInEdition(Identity<?> p_idRef)
Returns true if the specified Identity exists in an Edition |
java.util.Iterator<Edition> |
find(EditionQuery query)
Return Editions match search criteria |
PageIterator<Edition> |
find(EditionQuery query,
int resultsPerPage,
int firstPage)
Return Editions match search criteria with paging parameter. |
Edition |
get(Identity<Edition> editionId)
Retrieve the Edition that has the provided Id. |
Identity<Edition> |
getIdentity(java.lang.String editionId)
Retrieves an Identity object for the given edition unique Id. |
boolean |
hasEditions()
Returns true if any Editions have been created within the Repository |
Edition |
rename(Edition edition,
java.lang.String newName,
java.util.Locale localeOfName)
Renames the Edition to the new name. |
Methods inherited from interface com.ibm.portal.Disposable |
---|
dispose |
Method Detail |
---|
Edition create(java.lang.String name, java.util.Locale localeOfName) throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
Version
of all items in the WCM workspace.
Results in a new edition being created immediately.
name
- - name of the newly created EditionlocaleOfName
- - locale of the supplied name
Edition object representing the newly created Edition
- Throws:
com.ibm.workplace.wcm.api.exceptions.EditionException
- If there are any errors creating the Edition.
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have Administrator access to the WCM repository- Since:
- 8.5
boolean hasEditions()
boolean existsInEdition(Identity<?> p_idRef) throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
p_idRef
-
com.ibm.workplace.wcm.api.exceptions.EditionException
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
Edition get(Identity<Edition> editionId) throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
Edition
that has the provided Id.
editionId
- unique id of the Edition to retrieve
com.ibm.workplace.wcm.api.exceptions.EditionException
- If there are any errors retrieving the Edition.
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have Editor access to the WCM repositoryEdition rename(Edition edition, java.lang.String newName, java.util.Locale localeOfName) throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
Edition
to the new name. Rename takes affect immediately.
edition
- Edition to be renamednewName
- new name of the EditionlocaleOfName
- - locale of the supplied name
editionId
com.ibm.workplace.wcm.api.exceptions.EditionException
- If there are any errors retrieving the Edition.
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have Editor access to the WCM repositoryEditionQuery createQuery() throws com.ibm.workplace.wcm.api.exceptions.EditionException
EditionQuery
com.ibm.workplace.wcm.api.exceptions.EditionException
- if any error occurs generating the Query objectjava.util.Iterator<Edition> find(EditionQuery query) throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
query
- search criteria to use to locate Editions
com.ibm.workplace.wcm.api.exceptions.EditionException
- if any error occurs performing the search
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have Editor access to the WCM repositoryPageIterator<Edition> find(EditionQuery query, int resultsPerPage, int firstPage) throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
MaximumResults
value specified on the query
param
query
- search criteria to use to locate EditionsresultsPerPage
- how many results per pagefirstPage
- the first page of the return result
com.ibm.workplace.wcm.api.exceptions.EditionException
- if any error occurs performing the search
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have Editor access to the WCM repositorylong count(EditionQuery query) throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
query
- search criteria to use to locate Editions
com.ibm.workplace.wcm.api.exceptions.EditionException
- if any error occurs performing the search
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have Editor access to the WCM repositoryvoid delete(Edition edition) throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
edition
- to be deleted
com.ibm.workplace.wcm.api.exceptions.EditionException
- if any error occurs deleting the Edition
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have Administrator access to the WCM repositoryEditionDelta compare(Edition start, Edition end) throws com.ibm.workplace.wcm.api.exceptions.EditionException, com.ibm.workplace.wcm.api.exceptions.AuthorizationException
The Edition specified as start
must have bee created prior to end
Edition.
start
- the Edition that is to be used as the starting point of the comparisonend
- the Edition that is to be used as the ending point of the comparison
com.ibm.workplace.wcm.api.exceptions.EditionException
- is any error occurs comparing the Editions
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
- if the user does not have Editor access to the WCM repositoryIdentity<Edition> getIdentity(java.lang.String editionId) throws com.ibm.workplace.wcm.api.exceptions.EditionException
Identity
object for the given edition unique Id.
The editionId
should be a string that was previously returned from the getID() method of an existing Edition's Identity
editionId
- unique id of the Edition to retrieve an Identity for.
com.ibm.workplace.wcm.api.exceptions.EditionException
- is any error occurs in creating the Identity
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |