|
Oracle© Collaboration Suite Workspaces Web Services API Reference 10g Release 1 (10.1.2.2) Part No. B28209-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
TemplateService provides methods to perform operations on workspace templates.
A workspace template defines a blueprint of a workspace and typically captures the best practice for a specific activity, e.g., a consulting project, a RFP response, etc. A set of pre-defined templates is provided to create a workspace.
Only users with Application Administrator role can access the methods exposed in TemplateService.
The Axis specific code snippet given below illustrates template creation for a workspace.
// Invoke an instance of the template service locator and get a handle to template service. TemplateServiceService tss = new TemplateServiceServiceLocator(); TemplateService templateService = tss.getTemplateService(); // Instantiate a template definition object and set attributes. WorkspaceTemplateDefinition templateDef = new WorkspaceTemplateDefinition; templateDef.setMembersIncluded(false); templateDef.setSubworkspacesIncluded(false); //Settings for all workspace resources templateDef.setCalendarSetting("ALL_CALENDAR_EVENTS_NO_TASK"); templateDef.setDiscussionsSetting("ALL_ITEMS"); templateDef.setEmailSetting("NO_ITEMS"); templateDef.setFilesSetting("ALL_ITEMS_NO_FILE_CONTENT"); // The template name has to be unique templateDef.setTemplateName("MyNewTemplate"); templateDef.setTemplateAboutURL(TEMPLATE_URL); templateDef.setTemplateCategory(TEMPLATE_CATEGORY); templateDef.setTemplateDescription("MyNewTemplate description"); templateDef.setViewsSetting("ALL_ITEMS"); // Invoke method for creation of a workspace template. templateDef.setWorkspaceId(wspcId); //wspcId is the id of the workspace used to create the template. String strTemplate = templateService.createWorkspaceTemplate(templateDef);
Method Summary | |
java.lang.String |
createWorkspaceTemplate(WorkspaceTemplateDefinition tmplDef) Creates a template based on a given workspace. |
void |
deleteWorkspaceTemplate(java.lang.String templateName) Delete the template with given name |
WorkspaceTemplateItem |
getWorkspaceTemplate(java.lang.String templateName) Fetches the workspace template named |
java.lang.String |
getWorkspaceTemplateSchema() Retrieve schema for workspace template |
WorkspaceTemplateItem[] |
listWorkspaceTemplates() Returns the list of available workspace templates stored |
void |
storeWorkspaceTemplate(java.lang.String templateSpecification) Stores the given template in CwRepository |
Method Detail |
public java.lang.String createWorkspaceTemplate(WorkspaceTemplateDefinition tmplDef) throws CwWSException
tmplDef
- - options for creating the templateCwWSException
- - If the user does not have sufficient privileges or invalid template properties are specifiedpublic java.lang.String getWorkspaceTemplateSchema() throws CwWSException
CwWSException
- - If the user does not have sufficient privilegespublic void storeWorkspaceTemplate(java.lang.String templateSpecification) throws CwWSException
templateSpecification
- - XML specification for the template that conforms to the XML schema for workspace templates (http://www.oracle.com/cw/wstemplate)CwWSException
- - If the user does not have sufficient privileges, an invalid template specification is passed or the template already existspublic void deleteWorkspaceTemplate(java.lang.String templateName) throws CwWSException
templateName
- - name of the template to be droppedCwWSException
- - If the user does not have sufficient privileges to drop the template or or the the template does not exist.public WorkspaceTemplateItem getWorkspaceTemplate(java.lang.String templateName) throws CwWSException
templateName
- - name of the template to be fetchedCwWSException
- - If the user does not have sufficient privileges to fetch the template or the the template does not exist.public WorkspaceTemplateItem[] listWorkspaceTemplates() throws CwWSException
CwWSException
- - If the user does not have sufficient privileges to list the templates
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |