DocumentFolderService (Alfresco Mobile Android 1.5.1-SNAPSHOT)

All Superinterfaces:

android.os.Parcelable, Service

All Known Implementing Classes:

AbstractDocumentFolderServiceImpl, CloudDocumentFolderServiceImpl, OnPremiseDocumentFolderServiceImpl, PublicAPIDocumentFolderServiceImpl
```
public interface DocumentFolderService
extends Service
```
DocumentFolderService manages Folders and Documents in an Alfresco repository. The service provides methods to create and update nodes. The DocumentFolderService supports the following methods:
- Create nodes and set property values
- Read node properties and content, read and navigate node associations (browse folder)
- Update properties and content of nodes.
- Delete nodes. If the archive store is enabled, the node is not deleted but moved from its current node to the archive node store; nodes in the archive store can then be restored or purged.
Author:

Jean Marie Pascal

Nested Class Summary
- Nested classes/interfaces inherited from interface android.os.Parcelable
  android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FILTER_INCLUDE_LINKS` Filter to include links object in listing.
`static String`	`RENDITION_PREVIEW`
`static String`	`RENDITION_THUMBNAIL` Represent the unique identifier for thumbnail rendition.
`static String`	`SORT_PROPERTY_CREATED_AT` Allowable sorting property : Creation Date
`static String`	`SORT_PROPERTY_DESCRIPTION` Allowable sorting property : Description
`static String`	`SORT_PROPERTY_MODIFIED_AT` Allowable sorting property : Modification Date
`static String`	`SORT_PROPERTY_NAME` Allowable sorting property : Name of the document or folder.
`static String`	`SORT_PROPERTY_TITLE` Allowable sorting property : Title of the document or folder.

Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods
Modifier and Type	Method and Description
`Node`	`addAspects(Node node, List<String> aspects)` Adds the given aspects to the given node.
`void`	`addFavorite(Node node)` Marks the provided node as a favorite node.
`Document`	`createDocument(Folder parentFolder, String documentName, Map<String,Serializable> properties, ContentFile file)` Creates a document object in the specified location with an optional set of properties.
`Document`	`createDocument(Folder parentFolder, String documentName, Map<String,Serializable> properties, ContentFile file, List<String> aspects)` Creates a document object in the specified location with an optional set of properties.
`Document`	`createDocument(Folder parentFolder, String documentName, Map<String,Serializable> properties, ContentFile file, List<String> aspects, String type)` Creates a document object in the specified location with an optional set of properties.
`Folder`	`createFolder(Folder parentFolder, String folderName, Map<String,Serializable> properties)` Creates a folder object in the specified location with an optional set of properties and aspects.
`Folder`	`createFolder(Folder parentFolder, String folderName, Map<String,Serializable> properties, List<String> aspects)` Creates a folder object in the specified location with an optional set of properties and aspects.
`Folder`	`createFolder(Folder parentFolder, String folderName, Map<String,Serializable> properties, List<String> aspects, String type)` Creates a folder object in the specified location with an optional set of properties and aspects.
`void`	`deleteNode(Node node)` Deletes the specified node.
`Node`	`getChildByPath(Folder folder, String relativePath)` Gets the node object stored at the relative specified path from the folder object.
`Node`	`getChildByPath(String path)` Gets the node object stored at the specified path.
`List<Node>`	`getChildren(Folder folder)` Lists all immediate child nodes of the given context folder.
`PagingResult<Node>`	`getChildren(Folder folder, ListingContext listingContext)` Lists immediate child nodes of the given context folder.
`ContentFile`	`getContent(Document document)` Downloads the content for the given document.
`ContentStream`	`getContentStream(Document document)` Downloads the content for the given document as InputStream.
`List<Document>`	`getDocuments(Folder folder)` Lists all immediate child documents of the given context node Note: this could be a long list
`PagingResult<Document>`	`getDocuments(Folder folder, ListingContext listingContext)` Lists all immediate child documents of the given context folder.
`List<Document>`	`getFavoriteDocuments()` Returns a list of the current users favorite documents.
`PagingResult<Document>`	`getFavoriteDocuments(ListingContext listingContext)` Returns a paged list of the current users favorite documents.
`List<Folder>`	`getFavoriteFolders()` Returns a list of the current users favorite folders.
`PagingResult<Folder>`	`getFavoriteFolders(ListingContext listingContext)` Returns a paged list of the current users favorite folders.
`List<Node>`	`getFavoriteNodes()` Returns a list of the current users favorite nodes.
`PagingResult<Node>`	`getFavoriteNodes(ListingContext listingContext)` Returns a paged list of the current users favorite nodes.
`List<Folder>`	`getFolders(Folder folder)` Lists all immediate child folders of the given context folder.
`PagingResult<Folder>`	`getFolders(Folder folder, ListingContext listingContext)` Lists all immediate child folders of the given context folder.
`Node`	`getNodeByIdentifier(String identifier)`
`Folder`	`getParentFolder(Node node)` Gets the direct parent folder object.
`Permissions`	`getPermissions(Node node)`
`ContentFile`	`getRendition(Node node, String type)` Retrieve a specific type of Rendition for the specified identifier.
`ContentStream`	`getRenditionStream(Node node, String type)` Retrieve a specific type of Rendition for the specified identifier as InputStream
`Folder`	`getRootFolder()`
`boolean`	`isFavorite(Node node)` Determines whether the given node has been marked as a favorite by the current user.
`Node`	`refreshNode(Node node)` Returns the latest (and complete) metadata for the provided node.
`void`	`removeFavorite(Node node)` Removes the provided node from the current users favorites.
`Document`	`updateContent(Document document, ContentFile file)` Updates the content on the given document using the provided local file.
`Node`	`updateProperties(Node node, Map<String,Serializable> properties)` Updates the properties of the specified node.
`Node`	`updateProperties(Node node, Map<String,Serializable> properties, List<String> aspects)` Updates the properties for the given node and applies the given aspects.

Methods inherited from interface org.alfresco.mobile.android.api.services.Service
clear

Methods inherited from interface android.os.Parcelable
describeContents, writeToParcel

- Field Detail
  - SORT_PROPERTY_NAME
```
static final String SORT_PROPERTY_NAME
```
    Allowable sorting property : Name of the document or folder.
  - SORT_PROPERTY_TITLE
```
static final String SORT_PROPERTY_TITLE
```
    Allowable sorting property : Title of the document or folder.
  - SORT_PROPERTY_DESCRIPTION
```
static final String SORT_PROPERTY_DESCRIPTION
```
    Allowable sorting property : Description
  - SORT_PROPERTY_CREATED_AT
```
static final String SORT_PROPERTY_CREATED_AT
```
    Allowable sorting property : Creation Date
  - SORT_PROPERTY_MODIFIED_AT
```
static final String SORT_PROPERTY_MODIFIED_AT
```
    Allowable sorting property : Modification Date
  - FILTER_INCLUDE_LINKS
```
static final String FILTER_INCLUDE_LINKS
```
    Filter to include links object in listing.
    
    See Also:
    Constant Field Values
  - RENDITION_THUMBNAIL
```
static final String RENDITION_THUMBNAIL
```
    Represent the unique identifier for thumbnail rendition.
    
    See Also:
    getRendition(Node, String), Constant Field Values
  - RENDITION_PREVIEW
```
static final String RENDITION_PREVIEW
```
    See Also:
    Constant Field Values
- Method Detail
  - getChildren
```
List<Node> getChildren(Folder folder)
```
    Lists all immediate child nodes of the given context folder.
    By default, this list contains a maximum of 50 elements.
    Use getChildren(Folder, ListingContext) to change this behaviour.
    
    Parameters:
    folder - : context folder
    
    Returns:
    Returns a list of the immediate child nodes of the given folder.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
    See Also:
    getChildren(Folder, ListingContext)
  - getChildren
```
PagingResult<Node> getChildren(Folder folder,
                             ListingContext listingContext)
```
    Lists immediate child nodes of the given context folder.
    
    Parameters:
    folder - : context folder
    listingContext - : Listing context that define the behaviour of paging results ListingContext
    
    Returns:
    Returns a paged list of the immediate child nodes of the given folder.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - getChildByPath
```
Node getChildByPath(String path)
```
    Gets the node object stored at the specified path.
    
    Parameters:
    path - : path from the root folder.
    
    Returns:
    Returns the node object stored at the specified path.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - getChildByPath
```
Node getChildByPath(Folder folder,
                  String relativePath)
```
    Gets the node object stored at the relative specified path from the folder object.
    
    Parameters:
    folder - : context folder
    relativePath - : relative path from the root folder.
    
    Returns:
    Returns the node object stored at the given path relative from the given folder.
  - getNodeByIdentifier
```
Node getNodeByIdentifier(String identifier)
```
    Parameters:
    identifier -
    
    Returns:
    Returns the node object with the specified identifier.
  - getDocuments
```
List<Document> getDocuments(Folder folder)
```
    Lists all immediate child documents of the given context node
    Note: this could be a long list
    
    Parameters:
    folder - : context folder
    
    Returns:
    Returns a list of all immediate child documents of the given folder.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
    See Also:
    getDocuments(Folder, ListingContext)
  - getDocuments
```
PagingResult<Document> getDocuments(Folder folder,
                                  ListingContext listingContext)
```
    Lists all immediate child documents of the given context folder.
    
    Parameters:
    folder - : context folder
    listingContext - : defines the behavior of paging results ListingContext
    
    Returns:
    Returns a paged list of all immediate child documents of the given folder.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - getFolders
```
List<Folder> getFolders(Folder folder)
```
    Lists all immediate child folders of the given context folder.
    
    Parameters:
    folder - : Parent Folder
    
    Returns:
    Returns a list of all immediate child folders of the given folder.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
    See Also:
    getFolders(Folder, ListingContext)
  - getFolders
```
PagingResult<Folder> getFolders(Folder folder,
                              ListingContext listingContext)
```
    Lists all immediate child folders of the given context folder.
    
    Parameters:
    folder - : Parent Folder
    listingContext - : : defines the behaviour of paging results ListingContext
    
    Returns:
    Returns a paged list of all immediate child folders of the given folder.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
    See Also:
    getFolders(Folder)
  - getRootFolder
```
Folder getRootFolder()
```
    Returns:
    Returns the root folder of the repository.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - getParentFolder
```
Folder getParentFolder(Node node)
```
    Gets the direct parent folder object.
    
    Parameters:
    node - : Node object (Folder or Document).
    
    Returns:
    Returns the parent folder object of the given node, null if the node does not have a parent.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - createFolder
```
Folder createFolder(Folder parentFolder,
                  String folderName,
                  Map<String,Serializable> properties)
```
    Creates a folder object in the specified location with an optional set of properties and aspects.
    
    Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description
    
    A collection of default Alfresco aspects and properties are available inside the ContentModel
    
    Parameters:
    folder - : Parent Folder
    folderName - : Name of the future folder
    properties - : Map of properties to apply to the new folder
    
    Returns:
    the newly created folder
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - createFolder
```
Folder createFolder(Folder parentFolder,
                  String folderName,
                  Map<String,Serializable> properties,
                  List<String> aspects)
```
    Creates a folder object in the specified location with an optional set of properties and aspects.
    
    Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description
    Aspects must be a list of String that respect the format : namespace_name:aspect_name like cm:titled / cm:geographic.
    
    A collection of default Alfresco aspects and properties are available inside the ContentModel
    
    Parameters:
    folder - : Parent Folder
    folderName - : Name of the future folder
    properties - : Map of properties to apply to the new folder
    aspects - : List of aspects to apply to the new folder
    
    Returns:
    the newly created folder
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - createFolder
```
Folder createFolder(Folder parentFolder,
                  String folderName,
                  Map<String,Serializable> properties,
                  List<String> aspects,
                  String type)
```
    Creates a folder object in the specified location with an optional set of properties and aspects.
    
    Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description
    Aspects must be a list of String that respect the format : namespace_name:aspect_name like cm:titled / cm:geographic.
    Type value must respect the format : namespace_prefix:property_name like my:customfolder / cm:folder
    
    A collection of default Alfresco aspects and properties are available inside the ContentModel
    
    Parameters:
    folder - : Parent Folder
    folderName - : Name of the future folder
    properties - : Map of properties to apply to the new folder
    aspects - : List of aspects to apply to the new folder
    type - : custom type of the folder. If null it creates a default cm:folder.
    
    Returns:
    the newly created folder
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - createDocument
```
Document createDocument(Folder parentFolder,
                      String documentName,
                      Map<String,Serializable> properties,
                      ContentFile file)
```
    Creates a document object in the specified location with an optional set of properties. The content for the node is taken from the provided file.
    If the file parameter is not provided the document is created without content.
    If the session is bind to an onPremise server and depending on sessionSettings, this method can launch metadata extraction and thumbnail generation after creation.
    Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description
    
    A collection of default Alfresco aspects and properties are available inside the ContentModel
    
    Parameters:
    folder: - Future parent folder of a new document
    documentName -
    properties - : (Optional) list of property values that must be applied
    file - : (Optional) ContentFile that contains data stream or file
    
    Returns:
    the newly created document object.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - createDocument
```
Document createDocument(Folder parentFolder,
                      String documentName,
                      Map<String,Serializable> properties,
                      ContentFile file,
                      List<String> aspects)
```
    Creates a document object in the specified location with an optional set of properties. The content for the node is taken from the provided file.
    If the file parameter is not provided the document is created without content.
    If the session is bind to an onPremise server and depending on sessionSettings, this method can launch metadata extraction and thumbnail generation after creation.
    Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description
    Aspects must be a list of String that respect the format : namespace_name:aspect_name like cm:titled / cm:geographic.
    
    A collection of default Alfresco aspects and properties are available inside the ContentModel
    
    Parameters:
    folder: - Future parent folder of a new document
    documentName -
    properties - : (Optional) list of property values that must be applied
    aspects - : List of aspects to apply to the new folder
    file - : (Optional) ContentFile that contains data stream or file
    
    Returns:
    the newly created document object.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - createDocument
```
Document createDocument(Folder parentFolder,
                      String documentName,
                      Map<String,Serializable> properties,
                      ContentFile file,
                      List<String> aspects,
                      String type)
```
    Creates a document object in the specified location with an optional set of properties. The content for the node is taken from the provided file.
    If the file parameter is not provided the document is created without content.
    If the session is bind to an onPremise server and depending on sessionSettings, this method can launch metadata extraction and thumbnail generation after creation.
    Properties keys must respect the format : namespace_prefix:property_name like cm:name / cm:description
    Aspects must be a list of String that respect the format : namespace_name:aspect_name like cm:titled / cm:geographic.
    Type value must respect the format : namespace_prefix:property_name like my:customfolder / cm:folder
    
    A collection of default Alfresco aspects and properties are available inside the ContentModel
    
    Parameters:
    folder: - Future parent folder of a new document
    documentName -
    properties - : (Optional) list of property values that must be applied
    aspects - : List of aspects to apply to the new folder
    type - : custom type of the folder. If null it creates a default cm:folder.
    file - : (Optional) ContentFile that contains data stream or file
    
    Returns:
    the newly created document object.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - deleteNode
```
void deleteNode(Node node)
```
    Deletes the specified node.
    
    Parameters:
    node - : Node object (Folder or Document).
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - updateProperties
```
Node updateProperties(Node node,
                    Map<String,Serializable> properties)
```
    Updates the properties of the specified node. Can accept Alfresco Content Model Properties id or cmis properties id.
    
    Parameters:
    node - : Node to update
    properties - : Properties to update.
    
    Returns:
    Returns Newly update node.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - updateProperties
```
Node updateProperties(Node node,
                    Map<String,Serializable> properties,
                    List<String> aspects)
```
    Updates the properties for the given node and applies the given aspects. Can accept Alfresco Content Model Properties id or cmis properties id.
    
    Parameters:
    node - : Node to update
    properties - : Properties to update.
    aspects - : list of aspects to apply
    
    Returns:
    Returns Newly update node.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
    Since:
    
    1.4
  - addAspects
```
Node addAspects(Node node,
              List<String> aspects)
```
    Adds the given aspects to the given node.
    
    Parameters:
    node - Node to update
    aspects - : list of aspects to apply
    
    Returns:
    Returns Newly update node.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
    Since:
    
    1.4
  - updateContent
```
Document updateContent(Document document,
                     ContentFile file)
```
    Updates the content on the given document using the provided local file.
    
    Parameters:
    document - : Document object
    file - : File that is going to replace document content
    
    Returns:
    newly updated Document.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - getContent
```
ContentFile getContent(Document document)
```
    Downloads the content for the given document.
    
    Parameters:
    document - : Document object
    
    Returns:
    the contentFile representation that contains file informations + inputStream of the content.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - getContentStream
```
ContentStream getContentStream(Document document)
```
    Downloads the content for the given document as InputStream.
    
    Parameters:
    document - : Document object
    
    Returns:
    the contentFile representation that contains file informations + inputStream of the content.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - getPermissions
```
Permissions getPermissions(Node node)
```
    Parameters:
    node -
    
    Returns:
    Returns a Permissions object representing the allowed actions for the current user on the given node.
  - getRendition
```
ContentFile getRendition(Node node,
                       String type)
```
    Retrieve a specific type of Rendition for the specified identifier.
    
    Parameters:
    node - : Node (Document in general)
    type - : : Type of rendition available
    
    Returns:
    Returns a ContentFile object representing a rendition of the given node.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - getRenditionStream
```
ContentStream getRenditionStream(Node node,
                               String type)
```
    Retrieve a specific type of Rendition for the specified identifier as InputStream
    
    Parameters:
    node - : Node (Document in general)
    type - : : Type of rendition available
    
    Returns:
    Returns a ContentFile object representing a rendition of the given node.
    
    Throws:
    
    AlfrescoServiceException - : if network or internal problems occur during the process.
  - getFavoriteDocuments
```
List<Document> getFavoriteDocuments()
```
    Returns a list of the current users favorite documents.
    
    Returns:
    Since:
    
    1.2
  - getFavoriteDocuments
```
PagingResult<Document> getFavoriteDocuments(ListingContext listingContext)
```
    Returns a paged list of the current users favorite documents.
    
    Parameters:
    listingContext -
    
    Returns:
    Since:
    
    1.2
  - getFavoriteFolders
```
List<Folder> getFavoriteFolders()
```
    Returns a list of the current users favorite folders.
    
    Returns:
    Since:
    
    1.2
  - getFavoriteFolders
```
PagingResult<Folder> getFavoriteFolders(ListingContext listingContext)
```
    Returns a paged list of the current users favorite folders.
    
    Parameters:
    listingContext -
    
    Returns:
    Since:
    
    1.2
  - getFavoriteNodes
```
List<Node> getFavoriteNodes()
```
    Returns a list of the current users favorite nodes.
    
    Returns:
    Since:
    
    1.2
  - getFavoriteNodes
```
PagingResult<Node> getFavoriteNodes(ListingContext listingContext)
```
    Returns a paged list of the current users favorite nodes.
    
    Parameters:
    listingContext -
    
    Returns:
    Since:
    
    1.2
  - isFavorite
```
boolean isFavorite(Node node)
```
    Determines whether the given node has been marked as a favorite by the current user.
    
    Parameters:
    node -
    
    Returns:
    Since:
    
    1.2
  - addFavorite
```
void addFavorite(Node node)
```
    Marks the provided node as a favorite node.
    
    Parameters:
    node -
    Since:
    
    1.2
  - removeFavorite
```
void removeFavorite(Node node)
```
    Removes the provided node from the current users favorites.
    
    Parameters:
    node -
    Since:
    
    1.2
  - refreshNode
```
Node refreshNode(Node node)
```
    Returns the latest (and complete) metadata for the provided node.
    
    Parameters:
    node -
    
    Returns:
    Since:
    
    1.2

Interface DocumentFolderService

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Field Summary

Fields inherited from interface android.os.Parcelable

Method Summary

Methods inherited from interface org.alfresco.mobile.android.api.services.Service

Methods inherited from interface android.os.Parcelable

Field Detail

SORT_PROPERTY_NAME

SORT_PROPERTY_TITLE

SORT_PROPERTY_DESCRIPTION

SORT_PROPERTY_CREATED_AT

SORT_PROPERTY_MODIFIED_AT

FILTER_INCLUDE_LINKS

RENDITION_THUMBNAIL

RENDITION_PREVIEW

Method Detail

getChildren

getChildren

getChildByPath

getChildByPath

getNodeByIdentifier

getDocuments

getDocuments

getFolders

getFolders

getRootFolder

getParentFolder

createFolder

createFolder

createFolder

createDocument

createDocument

createDocument

deleteNode

updateProperties

updateProperties

addAspects

updateContent

getContent

getContentStream

getPermissions

getRendition

getRenditionStream

getFavoriteDocuments

getFavoriteDocuments

getFavoriteFolders

getFavoriteFolders

getFavoriteNodes

getFavoriteNodes

isFavorite

addFavorite

removeFavorite

refreshNode