Interface RecordFolderService

All Known Implementing Classes:
RecordFolderServiceImpl

@AlfrescoPublicApi public interface RecordFolderService
Record folder service interface
Since:
2.1
Author:
Roy Wetherall
  • Method Details

    • setupRecordFolder

      void setupRecordFolder(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(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(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(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

      NodeRef createRecordFolder(NodeRef rmContainer, String name, 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

      NodeRef createRecordFolder(NodeRef rmContainer, String name, QName type, Map<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

      NodeRef createRecordFolder(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

      NodeRef createRecordFolder(NodeRef rmContainer, String name, Map<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<NodeRef> getRecordFolders(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(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