|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CentraSiteObjectManager
CentraSiteObjectManager is used to manage the CentraSiteObjects, using this manager we can perform the operations like
1) Create the CentraSiteObject based on the given CentraSiteObjectType.
2) Retrieve the CentraSiteObject based on the given unique identifier.
3) Save/update one or more CentraSiteObject's.
4) Delete one or more CentraSiteObject's.
5) Create a new version of the CentraSiteRegistryObject.
6) Purge older versions of the CentraSiteRegistryObject.
CentraSiteObjectManager instantiated by the CentraSiteObjectFactory, the following is the sample code which will give you the reference to CentraSiteObjectManager.
CentraSiteObjectFacotry centraSiteObjectFactory = CentraSiteObjectFactory.getInstance(CentraSiteConnection);
CentraSiteObjectManager
centraSiteObjectManager = centraSiteObjectFactory.getCentraSiteObjectManager();
Method Summary | |
---|---|
CentraSiteInternationalString |
createInternationalString()
Creates an empty CentraSiteInternationalString. |
CentraSiteInternationalString |
createInternationalString(java.util.Locale locale,
java.lang.String value)
Creates an empty CentraSiteInternationalString with the specified locale and value. |
CentraSiteInternationalString |
createInternationalString(java.lang.String value)
Creates an empty CentraSiteInternationalString with the specified value and default locale. |
CentraSiteLocalizedString |
createLocalizedString(java.util.Locale locale,
java.lang.String value)
Creates a CentraSiteLocalizedString instance with the specified Locale and string parameters. |
CentraSiteLocalizedString |
createLocalizedString(java.util.Locale locale,
java.lang.String value,
java.lang.String charSetName)
Creates a CentraSiteLocalizedString instance with the specified Locale, string, and character set parameters. |
CentraSiteRegistryObject |
createNewVersion(CentraSiteRegistryObject csomRegistryObject)
Creates a new version of the given object. |
CentraSiteRegistryObject |
createNewVersion(CentraSiteRegistryObject csomRegistryObject,
java.lang.String userVersion,
Organization org,
boolean propagateVersion,
java.lang.String changeLog,
java.lang.String nameSpace)
Creates a new version of the given object. |
CentraSiteObject |
createObject(CentraSiteObjectType csoType)
Create the CentraSiteObject for the given CentraSiteObjectType. |
void |
deleteObjects(java.util.Collection<CentraSiteObject> csoList)
Delete the registry objects associated with the corresponding the CentraSiteObject |
CentraSiteRepositoryFolder |
getDefaultRepositoryFolder(CentraSiteObject centraSiteObject)
return the DefaultRepositoryFolder based on the given CentraSiteObject. |
java.util.Collection<CentraSiteRepositoryFile> |
getFiles(java.lang.String baseFolderRelativePath,
java.lang.String fileNamePattern)
Retrieve the files nested under the given base folder which matches the specified name pattern + ----------------- + | | | projects | + ----------------- + | + ----------------- + +-----------------+ | | | | | centrasite1 | - | centrasite3.txt | + ----------------- + +-----------------+ | + ----------------- + | | | centrasite2.txt | + ----------------- + in case of the above folder structure getFiles("/projects", "centrasite") return files /projects/centrasite1/centrasite3.txt and /projects/centrasite1/centrasite2.txt even though folder also contains the matching patterns it did not include in the result. |
java.util.Collection<CentraSiteRepositoryFolder> |
getFolders(java.lang.String baseFolderRelativePath,
java.lang.String folderNamePattern)
Retrieve the folders nested under the given base folder and matching the specified name pattern + ----------------- + | | | projects | + ----------------- + | + ----------------- + +-----------------+ | | | | | centrasite1 | - | centrasite3.txt | + ----------------- + +-----------------+ | + ----------------- + | | | centrasite2.txt | + ----------------- + in case of the above folder structure getFolders("/projects", "centrasite") return files /projects/centrasite1 even though files contain the matching patterns it did not include. |
CentraSiteObject |
getObject(java.lang.String id)
Populate the CentraSiteRegistryObject persisted using the given Unique Id. |
java.util.Collection<CentraSiteObject> |
getObjects(java.util.List<java.lang.String> ids)
Populate the list of CentraSiteObjects persisted using the given identifiers. |
void |
purgeVersions(CentraSiteRegistryObject csomRegistryObject)
Purges the previous versions of the given object. |
void |
saveObjects(java.util.Collection<CentraSiteObject> csoList)
Persists the given list of CentraSiteObject |
Method Detail |
---|
CentraSiteObject getObject(java.lang.String id) throws CLLException
id
- identifier which used to identify the registry object.
CLLException
- if CLL fails to populate the CentraSiteRegistryObject of the given identifier.java.util.Collection<CentraSiteObject> getObjects(java.util.List<java.lang.String> ids) throws CLLException
ids
- identifier which used to identify the registry object.
CLLException
- if CLL fails to populate the CentraSiteRegistryObject of the given identifier.CentraSiteObject createObject(CentraSiteObjectType csoType) throws CLLException
csoType
- type representation for CentraSiteObject
CLLException
- if CLL fails to populate the CentraSiteObject of the given type.void deleteObjects(java.util.Collection<CentraSiteObject> csoList) throws CLLException
csoList
- list of CentraSiteObjects
CLLException
- if CLL fails to delete any one of the CentraSiteObject.void saveObjects(java.util.Collection<CentraSiteObject> csoList) throws CLLException
csoList
- list of CentraSiteObjects
CLLException
- if CLL fails to save any one of the CentraSiteObject.CentraSiteInternationalString createInternationalString() throws CLLException
CLLException
- if CLL fails to create a CentraSiteInternationalString.CentraSiteInternationalString createInternationalString(java.lang.String value) throws CLLException
value
-
CLLException
- if CLL fails to create a CentraSiteInternationalString with the specified value and default locale.CentraSiteInternationalString createInternationalString(java.util.Locale locale, java.lang.String value) throws CLLException
locale
- value
-
CLLException
- if CLL fails to create a CentraSiteInternationalString with the specified locale and value.CentraSiteLocalizedString createLocalizedString(java.util.Locale locale, java.lang.String value) throws CLLException
locale
- value
-
CLLException
- if CLL fails to create a CentraSiteInternationalString instance with the specified Locale and string parameters.CentraSiteLocalizedString createLocalizedString(java.util.Locale locale, java.lang.String value, java.lang.String charSetName) throws CLLException
locale
- value
- charSetName
-
CLLException
- if CLL fails to create a CentraSiteLocalizedString instance with the specified Locale, string, and character set parameters.CentraSiteRegistryObject createNewVersion(CentraSiteRegistryObject csomRegistryObject, java.lang.String userVersion, Organization org, boolean propagateVersion, java.lang.String changeLog, java.lang.String nameSpace) throws CLLException
csomRegistryObject
- Reference to registry object which needs to be versioneduserVersion
- userVersion number for the newly versioned objectorg
- Organization for the newly versioned objectpropagateVersion
- Boolean flag indicating whether version change neeeds to be propagated to depedent objects or not.changeLog
- comments any while creating new versionnameSpace
-
CLLException
- If creation of new Version failsCentraSiteRegistryObject createNewVersion(CentraSiteRegistryObject csomRegistryObject) throws CLLException
csomRegistryObject
- Reference to registry object that needs to be versioned
CLLException
- if CLL fails to create a new version of the given object.void purgeVersions(CentraSiteRegistryObject csomRegistryObject) throws CLLException
csomRegistryObject
- list of registry objects whose older versions needs to be purged.
CLLException
- if CLL fails to purge the previous versions of the given object.java.util.Collection<CentraSiteRepositoryFile> getFiles(java.lang.String baseFolderRelativePath, java.lang.String fileNamePattern) throws CLLException
baseFolderRelativePath
- relative path of the webdav folder i.e /projects/SupportingDocuments/, if the value is null throw CLLException.fileNamePattern
- name that looking for the folder exists inside the baseFolder, if the value is null throw CLLException, in case of empty value return all folder in the given baseFolder.
CLLException
- in case of the given inputs is incorrect.java.util.Collection<CentraSiteRepositoryFolder> getFolders(java.lang.String baseFolderRelativePath, java.lang.String folderNamePattern) throws CLLException
baseFolderRelativePath
- relative path of the webdav folder i.e /projects/SupportingDocuments/,if the value is null throw CLLException.folderNamePattern
- name that looking for the folder exists inside the baseFolder, if the value is null throw CLLException, in case of empty value return all folder in the given baseFolder.
CLLException
- in case of the given inputs is incorrect.CentraSiteRepositoryFolder getDefaultRepositoryFolder(CentraSiteObject centraSiteObject) throws CLLException
centraSiteObject
- CentraSiteObject which the file repository resource needs to
create
CLLException
- in case of failed to get the DefaultRepositoryFolder for the
given CentraSiteObject.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |