|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface for managing
IDataEntryTemplate
s. Handles Data Entry
Template creation, removal, and retrieval.
IDataEntryTemplate.store
is called.
Refer to the Administrator Guide for AquaLogic Interaction Publisher (previously called Plumtree Content Server) for
additional details on Data Entry Template functionality.
Method Summary | |
IDataEntryTemplate |
createDataEntryTemplate(IFolder containingFolder,
java.lang.String name)
Creates a new IDataEntryTemplate . |
IDataEntryTemplate |
getDataEntryTemplate(IFolder folder,
java.lang.String name)
Retrieves an IDataEntryTemplate in a folder by its name. |
IDataEntryTemplate |
getDataEntryTemplate(java.lang.String uuid)
Returns an IDataEntryTemplate by its UUID. |
IDataEntryTemplate[] |
getDataEntryTemplates(IFolder folder)
Returns all IDataEntryTemplate s contained in a
given IFolder . |
void |
removeDataEntryTemplate(IDataEntryTemplate dataEntryTemplate)
Deletes the IDataEntryTemplate . |
Method Detail |
public IDataEntryTemplate createDataEntryTemplate(IFolder containingFolder, java.lang.String name)
IDataEntryTemplate
.
This method does not create a persistent object. To properly define
a Data Entry Template, use this method to create a new
template and add one or more properties to the template using
IDataEntryTemplate.addProperty
.
Any sub-type of IBaseProperty
can be added. When you are finished, use
IDataEntryTemplate.store
to
persist the Data Entry Template.
An IllegalStateException
will be thrown if the containing folder has not been stored.
containingFolder
- the folder the Data Entry Template
will be created in; cannot be null
name
- name of the template;
cannot be null
, empty, or longer than 255 characters.
The string used for the name will be trimmed of leading and trailing whitespace when it is stored
and is case-insensitive during name comparison.
IDataEntryTemplate
that has not been
persisted yet. Call IDataEntryTemplate.
store
to persist the template.
java.lang.IllegalStateException
- if specified folder
has not yet been stored or has already been removed
java.lang.IllegalArgumentException
- if the
name is an empty string or longer than 255 characterspublic IDataEntryTemplate getDataEntryTemplate(IFolder folder, java.lang.String name) throws ContentSecurityException, ContentException, java.rmi.RemoteException
IDataEntryTemplate
in a folder by its name.
The specified name is the full name of the Data Entry Template.
The name
will be trimmed of leading and trailing whitespace
and is case-insensitive for comparison.
The name
does not support wildcards.
// Assuming a dataEntryTemplate is persisted in containingFolder // Retrieve the Data Entry Template by name IDataEntryTemplate sameDataEntryTemplate = dataEntryTemplateManager.getDataEntryTemplate(containingFolder, dataEntryTemplate.getName()); // sameDataEntryTemplate.getUUID() is the same as dataEntryTemplate.GetUUID()
folder
- the folder containing the
IDataEntryTemplate
; cannot be null
name
- name of the IDataEntryTemplate
;
cannot be null
, empty, or longer than 255 characters.
The string used for the name will be trimmed of leading and trailing whitespace
and is case-insensitive during comparison.
IDataEntryTemplate
in the
folder with the specified name; otherwise null
ContentException
- if the method call resulted
in a Publisher exception
java.rmi.RemoteException
- if there was a communication
problem during the execution of the remote method call
java.lang.IllegalStateException
- if the folder has not
yet been stored or has already been removed
ContentSecurityException
- if the user does not have
permission to access the folder
java.lang.IllegalArgumentException
- if the
name is an empty string or longer than 255 characterspublic IDataEntryTemplate getDataEntryTemplate(java.lang.String uuid) throws ContentSecurityException, ContentException, java.rmi.RemoteException
IDataEntryTemplate
by its UUID.
uuid
- the IDataEntryTemplate
UUID;
cannot be null
, empty or longer than 255 characters.
The UUID of an object can be obtained using the
getUUID
method
in the IDataEntryTemplate
class.
IDataEntryTemplate
or
null
if the template does not exist
java.lang.IllegalArgumentException
- if the
UUID is an empty string or longer than 255 characters
ContentSecurityException
- if the user does not have
permission to access the Data Entry Template
ContentException
- if the method call resulted in a Publisher exception
java.rmi.RemoteException
- if there was a communication problem
during the execution of the remote method callpublic IDataEntryTemplate[] getDataEntryTemplates(IFolder folder) throws ContentSecurityException, ContentException, java.rmi.RemoteException
IDataEntryTemplate
s contained in a
given IFolder
.
folder
- the folder to retrieve Data
Entry Templates from; cannot be null
IDataEntryTemplate
s in
the specified folder. The returned array is not ordered.
ContentException
- if the method call resulted in a Publisher exception
java.rmi.RemoteException
- if there was a communication
problem during the execution of the remote method call
java.lang.IllegalStateException
- if the folder has not yet
been stored or has already been removed
ContentSecurityException
- if the user does not have permission to access the folderpublic void removeDataEntryTemplate(IDataEntryTemplate dataEntryTemplate) throws ContentSecurityException, ContentException, java.rmi.RemoteException
IDataEntryTemplate
. Note: All the associated
content items will be deleted if the underlying Data Entry Template is deleted.
dataEntryTemplate
- the Data Entry Template to
be deleted; cannot be null
ContentSecurityException
- if the user does not
have permission to delete the Data Entry Template
ContentException
- if the method call resulted
in a Publisher exception
java.rmi.RemoteException
- if there was a communication
problem during the execution of the remote method call
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.