oracle.workspaces.template
Class CwWorkspaceTemplateDefinition

java.lang.Object
oracle.workspaces.template.CwWorkspaceTemplateDefinition

public class CwWorkspaceTemplateDefinition

extends java.lang.Object

used for creating a template from a given workspace

Nested Class Summary

static class

CwWorkspaceTemplateDefinition.ResourceTypeSetting

Field Summary

static CwWorkspaceTemplateDefinition.ResourceTypeSetting	ALL_ITEMS
static CwWorkspaceTemplateDefinition.ResourceTypeSetting	ALL_ITEMS_NO_FILE_CONTENT
static CwWorkspaceTemplateDefinition.ResourceTypeSetting	ALL_ITEMS_NO_VIEW_CONTENT
static CwWorkspaceTemplateDefinition.ResourceTypeSetting	NO_ITEMS
static CwWorkspaceTemplateDefinition.ResourceTypeSetting	SKIP_RESOURCE_TYPE

Constructor Summary

CwWorkspaceTemplateDefinition(CwWorkspace workspace, java.lang.String templateName, java.lang.String description, java.lang.String createdBy, java.lang.String createdOn)

Method Summary

boolean	areMembersIncluded()
boolean	areSubworkspacesIncluded()
CwWorkspaceTemplateDefinition.ResourceTypeSetting	getResourceTypeSetting(CwResourceType resType) Returns the setting for this resource type.
java.lang.String	getTemplateAboutURL()
java.lang.String	getTemplateCategory()
java.lang.String	getTemplateCreatedBy()
java.lang.String	getTemplateCreatedOn()
java.lang.String	getTemplateDescription()
java.lang.String	getTemplateName()
CwWorkspace	getWorkspace()
void	includeMembers(boolean setting)
void	includeSubworkspaces(boolean setting)
void	setResourceTypeSetting(CwResourceType resType, CwWorkspaceTemplateDefinition.ResourceTypeSetting setting) Sets the setting for the given resource type.
void	setTemplateAboutURL(java.lang.String url)
void	setTemplateCategory(java.lang.String category)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_ITEMS

public static CwWorkspaceTemplateDefinition.ResourceTypeSetting ALL_ITEMS

ALL_ITEMS_NO_FILE_CONTENT

public static CwWorkspaceTemplateDefinition.ResourceTypeSetting ALL_ITEMS_NO_FILE_CONTENT

ALL_ITEMS_NO_VIEW_CONTENT

public static CwWorkspaceTemplateDefinition.ResourceTypeSetting ALL_ITEMS_NO_VIEW_CONTENT

NO_ITEMS

public static CwWorkspaceTemplateDefinition.ResourceTypeSetting NO_ITEMS

SKIP_RESOURCE_TYPE

public static CwWorkspaceTemplateDefinition.ResourceTypeSetting SKIP_RESOURCE_TYPE

Constructor Detail

CwWorkspaceTemplateDefinition

public CwWorkspaceTemplateDefinition(CwWorkspace workspace,
                                     java.lang.String templateName,
                                     java.lang.String description,
                                     java.lang.String createdBy,
                                     java.lang.String createdOn)

Parameters:

workspace - the workspace from which the template will be created

Method Detail

areMembersIncluded

public boolean areMembersIncluded()

areSubworkspacesIncluded

public boolean areSubworkspacesIncluded()

getResourceTypeSetting

public CwWorkspaceTemplateDefinition.ResourceTypeSetting getResourceTypeSetting(CwResourceType resType)

Returns the setting for this resource type. The possible values of resource type setting are:

• SKIP_RESOURCE_TYPE : This resource type will not be included in the template
• ALL_ITEMS: All resource items for this resource type will be included in the template
• NO_ITEMS: No resource item for this resource type will be included in the template. Only the the resource of this type along with its properties will be included.
• ALL_ITEMS_NO_FILE_CONTENT: This setting applies only to the Files resource. It means all items will be included but file bodies will not be included.

getTemplateAboutURL

public java.lang.String getTemplateAboutURL()

getTemplateCategory

public java.lang.String getTemplateCategory()

getTemplateCreatedBy

public java.lang.String getTemplateCreatedBy()

getTemplateCreatedOn

public java.lang.String getTemplateCreatedOn()

getTemplateDescription

public java.lang.String getTemplateDescription()

getTemplateName

public java.lang.String getTemplateName()

getWorkspace

public CwWorkspace getWorkspace()

includeMembers

public void includeMembers(boolean setting)

includeSubworkspaces

public void includeSubworkspaces(boolean setting)

setResourceTypeSetting

public void setResourceTypeSetting(CwResourceType resType,
                                   CwWorkspaceTemplateDefinition.ResourceTypeSetting setting)
                            throws CwException

Sets the setting for the given resource type. See getResourceTypeSetting(oracle.workspaces.CwResourceType) for details on setting.

Throws:

CwException

setTemplateAboutURL

public void setTemplateAboutURL(java.lang.String url)

setTemplateCategory

public void setTemplateCategory(java.lang.String category)