org.alfresco.module.org_alfresco_module_rm.fileplan

Interface FilePlanService

All Known Implementing Classes:

FilePlanServiceImpl

@AlfrescoPublicApi
public interface FilePlanService

File plan service interface.

Since:

2.1

Author:

Roy Wetherall

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_RM_SITE_ID Default RM site id.

Method Summary

Modifier and Type	Method and Description
org.alfresco.service.cmr.repository.NodeRef	createFilePlan(org.alfresco.service.cmr.repository.NodeRef parent, String name) Creates a file plan with the default type.
org.alfresco.service.cmr.repository.NodeRef	createFilePlan(org.alfresco.service.cmr.repository.NodeRef parent, String name, Map<org.alfresco.service.namespace.QName,Serializable> properties) Creates a file plan with the default type, specifying properties.
org.alfresco.service.cmr.repository.NodeRef	createFilePlan(org.alfresco.service.cmr.repository.NodeRef parent, String name, org.alfresco.service.namespace.QName type) Creates a file plan as a child of the given parent node, with the name provided.
org.alfresco.service.cmr.repository.NodeRef	createFilePlan(org.alfresco.service.cmr.repository.NodeRef parent, String name, org.alfresco.service.namespace.QName type, Map<org.alfresco.service.namespace.QName,Serializable> properties) Specifies the properties to be set on the created file plan.
org.alfresco.service.cmr.repository.NodeRef	createHoldContainer(org.alfresco.service.cmr.repository.NodeRef filePlan)
org.alfresco.service.cmr.repository.NodeRef	createRecordCategory(org.alfresco.service.cmr.repository.NodeRef parent, String name) Creates a record category of type rma:recordCategory
org.alfresco.service.cmr.repository.NodeRef	createRecordCategory(org.alfresco.service.cmr.repository.NodeRef parent, String name, Map<org.alfresco.service.namespace.QName,Serializable> properties)
org.alfresco.service.cmr.repository.NodeRef	createRecordCategory(org.alfresco.service.cmr.repository.NodeRef parent, String name, org.alfresco.service.namespace.QName type) Create a record category.
org.alfresco.service.cmr.repository.NodeRef	createRecordCategory(org.alfresco.service.cmr.repository.NodeRef parent, String name, org.alfresco.service.namespace.QName type, Map<org.alfresco.service.namespace.QName,Serializable> properties)
org.alfresco.service.cmr.repository.NodeRef	createTransferContainer(org.alfresco.service.cmr.repository.NodeRef filePlan)
org.alfresco.service.cmr.repository.NodeRef	createUnfiledContainer(org.alfresco.service.cmr.repository.NodeRef filePlan) Creates, and returns, a unfiled container for a given file plan.
boolean	existsUnfiledContainer(org.alfresco.service.cmr.repository.NodeRef filePlan) Indicates whether the unfiled container exists for a given file plan or not.
List<org.alfresco.service.cmr.repository.NodeRef>	getAllContained(org.alfresco.service.cmr.repository.NodeRef recordCategory) Only return the immediate children.
List<org.alfresco.service.cmr.repository.NodeRef>	getAllContained(org.alfresco.service.cmr.repository.NodeRef recordCategory, boolean deep) Get all the items contained within a container.
List<org.alfresco.service.cmr.repository.NodeRef>	getContainedRecordCategories(org.alfresco.service.cmr.repository.NodeRef recordCategory) Only return immediate children.
List<org.alfresco.service.cmr.repository.NodeRef>	getContainedRecordCategories(org.alfresco.service.cmr.repository.NodeRef recordCategory, boolean deep) Get all the record categories within a record category.
List<org.alfresco.service.cmr.repository.NodeRef>	getContainedRecordFolders(org.alfresco.service.cmr.repository.NodeRef container) Only return immediate children.
List<org.alfresco.service.cmr.repository.NodeRef>	getContainedRecordFolders(org.alfresco.service.cmr.repository.NodeRef container, boolean deep) Get all the record folders contained within a container
org.alfresco.service.cmr.repository.NodeRef	getFilePlan(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the file plan the node is in.
org.alfresco.service.cmr.repository.NodeRef	getFilePlanBySiteId(String siteId) Gets a file plan by site id.
FilePlanComponentKind	getFilePlanComponentKind(org.alfresco.service.cmr.repository.NodeRef nodeRef) Returns the 'kind' of file plan component the node reference is.
FilePlanComponentKind	getFilePlanComponentKindFromType(org.alfresco.service.namespace.QName type) Returns the file plan component 'kind' that relates to the passed content type.
Set<org.alfresco.service.cmr.repository.NodeRef>	getFilePlans() Gets all the file plan nodes.
Set<org.alfresco.service.cmr.repository.NodeRef>	getFilePlans(org.alfresco.service.cmr.repository.StoreRef storeRef) Getse all the file plan nodes in a store.
org.alfresco.service.cmr.repository.NodeRef	getHoldContainer(org.alfresco.service.cmr.repository.NodeRef filePlan) Gets the hold container for a given file plan.
List<org.alfresco.service.cmr.repository.NodeRef>	getNodeRefPath(org.alfresco.service.cmr.repository.NodeRef nodeRef) Gets the NodeRef sequence from the root down to the fileplan component given.
org.alfresco.service.cmr.repository.NodeRef	getTransferContainer(org.alfresco.service.cmr.repository.NodeRef filePlan)
org.alfresco.service.cmr.repository.NodeRef	getUnfiledContainer(org.alfresco.service.cmr.repository.NodeRef filePlan) Gets the unfiled container for a given file plan.
boolean	isFilePlan(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether the given node is file plan node or not.
boolean	isFilePlanComponent(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether the given node is a file plan component or not.
boolean	isFilePlanContainer(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether the given node is a file plan container or not.
boolean	isRecordCategory(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether the given node is a record category or not.

Field Detail

DEFAULT_RM_SITE_ID

static final String DEFAULT_RM_SITE_ID

Default RM site id. Can be used with getFilePlanBySiteId(String) to get the file plan node.

See Also:

Constant Field Values

Method Detail

isFilePlanComponent

boolean isFilePlanComponent(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Indicates whether the given node is a file plan component or not.

Parameters:

nodeRef - node reference

Returns:

boolean true if a file plan component, false otherwise

getFilePlanComponentKind

FilePlanComponentKind getFilePlanComponentKind(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Returns the 'kind' of file plan component the node reference is.

Returns null if the given node reference is not a file plan component.

Parameters:

nodeRef - node reference

Returns:

FilePlanComponentKind the kind of file plan component the node is

getFilePlanComponentKindFromType

FilePlanComponentKind getFilePlanComponentKindFromType(org.alfresco.service.namespace.QName type)

Returns the file plan component 'kind' that relates to the passed content type.

Returns null if the type does not relate to a file plan component.

Parameters:

type - qualified name of content type

Returns:

FilePlanComponentKind the kind relating to the passed type

isFilePlan

boolean isFilePlan(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Indicates whether the given node is file plan node or not.

Parameters:

nodeRef - node reference

Returns:

boolean true if node is a file plan node

getFilePlans

Set<org.alfresco.service.cmr.repository.NodeRef> getFilePlans()

Gets all the file plan nodes. Looks in the SpacesStore by default.

Returns:

Set set of file plan nodes

getFilePlans

Set<org.alfresco.service.cmr.repository.NodeRef> getFilePlans(org.alfresco.service.cmr.repository.StoreRef storeRef)

Getse all the file plan nodes in a store.

Parameters:

storeRef - store reference

Returns:

Set set of file plan nodes

getFilePlan

org.alfresco.service.cmr.repository.NodeRef getFilePlan(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Gets the file plan the node is in.

Returns:

NodeRef file node reference, null if none

getFilePlanBySiteId

org.alfresco.service.cmr.repository.NodeRef getFilePlanBySiteId(String siteId)

Gets a file plan by site id. Assumes the site is a RM site and that the file plan node, ie the document library container, has been already created. Otherwise returns null.

Parameters:

siteId - records management site id

Returns:

NodeRef file plan, null if can't be found

existsUnfiledContainer

boolean existsUnfiledContainer(org.alfresco.service.cmr.repository.NodeRef filePlan)

Indicates whether the unfiled container exists for a given file plan or not.

Parameters:

filePlan - file plan

Returns:

boolean true if unfiled container exists, false otherwise

getUnfiledContainer

org.alfresco.service.cmr.repository.NodeRef getUnfiledContainer(org.alfresco.service.cmr.repository.NodeRef filePlan)

Gets the unfiled container for a given file plan. Returns null if none.

Parameters:

filePlan - file plan

Returns:

NodeRef unfiled container, null if none

createUnfiledContainer

org.alfresco.service.cmr.repository.NodeRef createUnfiledContainer(org.alfresco.service.cmr.repository.NodeRef filePlan)

Creates, and returns, a unfiled container for a given file plan.

Parameters:

filePlan - file plan

Returns:

Node unfiled container

getHoldContainer

org.alfresco.service.cmr.repository.NodeRef getHoldContainer(org.alfresco.service.cmr.repository.NodeRef filePlan)

Gets the hold container for a given file plan. Returns null if none.

Parameters:

filePlan -

Returns:

createHoldContainer

org.alfresco.service.cmr.repository.NodeRef createHoldContainer(org.alfresco.service.cmr.repository.NodeRef filePlan)

Parameters:

filePlan -

Returns:

getTransferContainer

org.alfresco.service.cmr.repository.NodeRef getTransferContainer(org.alfresco.service.cmr.repository.NodeRef filePlan)

Parameters:

filePlan -

Returns:

createTransferContainer

org.alfresco.service.cmr.repository.NodeRef createTransferContainer(org.alfresco.service.cmr.repository.NodeRef filePlan)

Parameters:

filePlan -

Returns:

createFilePlan

org.alfresco.service.cmr.repository.NodeRef createFilePlan(org.alfresco.service.cmr.repository.NodeRef parent,
                                                           String name,
                                                           org.alfresco.service.namespace.QName type)

Creates a file plan as a child of the given parent node, with the name provided.

Parameters:

parent - parent node reference

name - file plan name

type - type, must be rma:filePlan or sub-type of

Returns:

NodeRef file plan node reference

createFilePlan

org.alfresco.service.cmr.repository.NodeRef createFilePlan(org.alfresco.service.cmr.repository.NodeRef parent,
                                                           String name,
                                                           org.alfresco.service.namespace.QName type,
                                                           Map<org.alfresco.service.namespace.QName,Serializable> properties)

Specifies the properties to be set on the created file plan.

Parameters:

parent - parent node reference

name - file plan name

type - type, must be rma:filePlan or sub-type of

properties - file plan properties

Returns:

NodeRef file plan node reference

See Also:

createFilePlan(NodeRef, String, QName)

createFilePlan

org.alfresco.service.cmr.repository.NodeRef createFilePlan(org.alfresco.service.cmr.repository.NodeRef parent,
                                                           String name)

Creates a file plan with the default type.

Parameters:

parent - parent node reference

name - file plan name

Returns:

NodeRef file plan node reference

See Also:

createFilePlan(NodeRef, String, QName)

createFilePlan

org.alfresco.service.cmr.repository.NodeRef createFilePlan(org.alfresco.service.cmr.repository.NodeRef parent,
                                                           String name,
                                                           Map<org.alfresco.service.namespace.QName,Serializable> properties)

Creates a file plan with the default type, specifying properties.

Parameters:

parent - parent node reference

name - file plan name

properties - file plan properties

Returns:

NodeRef file plan node reference

See Also:

createFilePlan(NodeRef, String, QName)

getNodeRefPath

List<org.alfresco.service.cmr.repository.NodeRef> getNodeRefPath(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Gets the NodeRef sequence from the root down to the fileplan component given. The array will start with the NodeRef of the root and end with the name of the fileplan component node given.

Parameters:

nodeRef - a fileplan component

Returns:

Returns a NodeRef path starting with the file plan

isFilePlanContainer

boolean isFilePlanContainer(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Indicates whether the given node is a file plan container or not.

This includes file plan and record category nodes.

Parameters:

nodeRef - node reference

Returns:

boolean true if node is a file plan container, false otherwise.

isRecordCategory

boolean isRecordCategory(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Indicates whether the given node is a record category or not.

Parameters:

nodeRef - node reference

Returns:

boolean true if records category, false otherwise

getAllContained

List<org.alfresco.service.cmr.repository.NodeRef> getAllContained(org.alfresco.service.cmr.repository.NodeRef recordCategory,
                                                                  boolean deep)

Get all the items contained within a container. This will include record folders and other record categories.

Parameters:

recordCategory - record category node reference

deep - if true then return all children including sub-categories and their children in turn, if false then just return the immediate children

Returns:

List<NodeRef> list of contained node references

getAllContained

List<org.alfresco.service.cmr.repository.NodeRef> getAllContained(org.alfresco.service.cmr.repository.NodeRef recordCategory)

Only return the immediate children.

Parameters:

recordCategory - record category node reference

Returns:

List<NodeRef> list of contained node references

getContainedRecordCategories

List<org.alfresco.service.cmr.repository.NodeRef> getContainedRecordCategories(org.alfresco.service.cmr.repository.NodeRef recordCategory,
                                                                               boolean deep)

Get all the record categories within a record category.

Parameters:

recordCategory - record category node reference

deep - if true then return all children including sub-categories and their children in turn, if false then just return the immediate children

Returns:

List<NodeRef> list of container node references

getContainedRecordCategories

List<org.alfresco.service.cmr.repository.NodeRef> getContainedRecordCategories(org.alfresco.service.cmr.repository.NodeRef recordCategory)

Only return immediate children.

Parameters:

recordCategory - container node reference

Returns:

List<NodeRef> list of container node references

getContainedRecordFolders

List<org.alfresco.service.cmr.repository.NodeRef> getContainedRecordFolders(org.alfresco.service.cmr.repository.NodeRef container,
                                                                            boolean deep)

Get all the record folders contained within a container

Parameters:

container - container node reference

deep - if true then return all children including sub-containers and their children in turn, if false then just return the immediate children

Returns:

List<NodeRef> list of record folder node references

getContainedRecordFolders

List<org.alfresco.service.cmr.repository.NodeRef> getContainedRecordFolders(org.alfresco.service.cmr.repository.NodeRef container)

Only return immediate children.

Parameters:

container - container node reference

Returns:

List<NodeRef> list of record folder node references

createRecordCategory

org.alfresco.service.cmr.repository.NodeRef createRecordCategory(org.alfresco.service.cmr.repository.NodeRef parent,
                                                                 String name,
                                                                 org.alfresco.service.namespace.QName type)

Create a record category.

Parameters:

parent - parent node reference, must be a record category or file plan.

name - name of the new record category

type - type of container to create, must be a sub-type of rm:recordCategory

Returns:

NodeRef node reference of the created record category

createRecordCategory

org.alfresco.service.cmr.repository.NodeRef createRecordCategory(org.alfresco.service.cmr.repository.NodeRef parent,
                                                                 String name,
                                                                 org.alfresco.service.namespace.QName type,
                                                                 Map<org.alfresco.service.namespace.QName,Serializable> properties)

Parameters:

parent -

name -

type -

properties -

Returns:

createRecordCategory

org.alfresco.service.cmr.repository.NodeRef createRecordCategory(org.alfresco.service.cmr.repository.NodeRef parent,
                                                                 String name)

Creates a record category of type rma:recordCategory

Parameters:

parent - parent node reference, must be a record category or file plan.

name - name of the record category

Returns:

NodeRef node reference of the created record category

createRecordCategory

org.alfresco.service.cmr.repository.NodeRef createRecordCategory(org.alfresco.service.cmr.repository.NodeRef parent,
                                                                 String name,
                                                                 Map<org.alfresco.service.namespace.QName,Serializable> properties)

Parameters:

parent -

name -

properties -

Returns: