org.alfresco.module.org_alfresco_module_rm.recordfolder

Interface RecordFolderService

All Known Implementing Classes:

RecordFolderServiceImpl

@AlfrescoPublicApi
public interface RecordFolderService

Record folder service interface

Since:

2.1

Author:

Roy Wetherall

Method Summary

Modifier and Type	Method and Description
void	closeRecordFolder(org.alfresco.service.cmr.repository.NodeRef nodeRef) Closes the record folder.
org.alfresco.service.cmr.repository.NodeRef	createRecordFolder(org.alfresco.service.cmr.repository.NodeRef rmContainer, String name) Create a record folder in the rm container.
org.alfresco.service.cmr.repository.NodeRef	createRecordFolder(org.alfresco.service.cmr.repository.NodeRef rmContainer, String name, Map<org.alfresco.service.namespace.QName,Serializable> properties) Create a record folder in the rm container.
org.alfresco.service.cmr.repository.NodeRef	createRecordFolder(org.alfresco.service.cmr.repository.NodeRef rmContainer, String name, org.alfresco.service.namespace.QName type) Create a record folder in the rm container.
org.alfresco.service.cmr.repository.NodeRef	createRecordFolder(org.alfresco.service.cmr.repository.NodeRef rmContainer, String name, org.alfresco.service.namespace.QName type, Map<org.alfresco.service.namespace.QName,Serializable> properties) Create a record folder in the rm container.
List<org.alfresco.service.cmr.repository.NodeRef>	getRecordFolders(org.alfresco.service.cmr.repository.NodeRef record) Get all the record folders that a record is filed into.
boolean	isRecordFolder(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether the given node is a record folder or not.
boolean	isRecordFolderClosed(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether a record folder is closed or not.
boolean	isRecordFolderDeclared(org.alfresco.service.cmr.repository.NodeRef nodeRef) Indicates whether the contents of a record folder are all declared.
void	setupRecordFolder(org.alfresco.service.cmr.repository.NodeRef nodeRef) Sets up the a record folder from a standard folder.

Method Detail

setupRecordFolder

void setupRecordFolder(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Sets up the a record folder from a standard folder.

Parameters:

nodeRef - node reference of the folder to setup

Since:

2.2

isRecordFolder

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

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

Parameters:

nodeRef - node reference

Returns:

boolean true if record folder, false otherwise

Since:

2.2

isRecordFolderDeclared

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

Indicates whether the contents of a record folder are all declared.

Parameters:

nodeRef - node reference (record folder)

Returns:

boolean true if record folder contents are declared, false otherwise

Since:

2.2

isRecordFolderClosed

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

Indicates whether a record folder is closed or not.

Parameters:

nodeRef - node reference (record folder)

Returns:

boolean true if record folder is closed, false otherwise

Since:

2.2

createRecordFolder

org.alfresco.service.cmr.repository.NodeRef createRecordFolder(org.alfresco.service.cmr.repository.NodeRef rmContainer,
                                                               String name,
                                                               org.alfresco.service.namespace.QName type)

Create a record folder in the rm container. The record folder will take the name and type provided.

Parameters:

rmContainer - records management container

name - name

type - type

Returns:

NodeRef node reference of record folder

Since:

2.2

createRecordFolder

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

Create a record folder in the rm container. The record folder will take the name, type and properties provided.

Parameters:

rmContainer - records management container

name - name

type - type

properties - properties

Returns:

NodeRef node reference of record folder

Since:

2.2

createRecordFolder

org.alfresco.service.cmr.repository.NodeRef createRecordFolder(org.alfresco.service.cmr.repository.NodeRef rmContainer,
                                                               String name)

Create a record folder in the rm container. The record folder will take the name provided. Type defaults to rm:recordFolder.

Parameters:

rmContainer - records management container

name - name

Returns:

NodeRef node reference of record folder

Since:

2.2

createRecordFolder

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

Create a record folder in the rm container. The record folder will take the name and properties provided. Type defaults to rm:recordFolder.

Parameters:

rmContainer - records management container

name - name

properties - properties

Returns:

NodeRef node reference of record folder

Since:

2.2

getRecordFolders

List<org.alfresco.service.cmr.repository.NodeRef> getRecordFolders(org.alfresco.service.cmr.repository.NodeRef record)

Get all the record folders that a record is filed into.

Parameters:

record - the record node reference

Returns:

List list of folder record node references

Since:

2.2

closeRecordFolder

void closeRecordFolder(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Closes the record folder. If the given node reference is a record the parent will be retrieved and processed.

Parameters:

nodeRef - the record folder node reference

Since:

2.2