org.alfresco.mobile.android.api.model.impl

Class NodeImpl

java.lang.Object

org.alfresco.mobile.android.api.model.impl.NodeImpl

All Implemented Interfaces:

android.os.Parcelable, Serializable, Node

Direct Known Subclasses:

DocumentImpl, DocumentLinkImpl, FolderImpl, LinkImpl

public class NodeImpl
extends Object
implements Node

Base Implementation of Alfresco Node object.

Author:

Jean Marie Pascal

See Also:

Serialized Form

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 android.os.Parcelable.Creator<NodeImpl>

CREATOR Android specific internal methods to retrieve information depending on state. By state it means that a node is created by a "cmisobject" so parameter object is not null if configuration change (orientation screen change...) the parameter object is not saved so become null. To save informations (properties, aspects...), Android can use Parcel object that can store important information. This method is similar as "deserialization" in java world.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
NodeImpl()
NodeImpl(org.apache.chemistry.opencmis.client.api.CmisObject o) Default constructor of a Node based on CMIS service and object.
NodeImpl(org.apache.chemistry.opencmis.client.api.CmisObject o, boolean hasAllProperties)
NodeImpl(android.os.Parcel o) Constructor of a Node object depending of a Parcel object previously created by writeToParcel method.

Method Summary

Methods

Modifier and Type	Method and Description
int	describeContents()
Set<String>	getAllowableActions()
List<String>	getAspects() Returns all the aspects applied to the node.
GregorianCalendar	getCreatedAt() Returns the timestamp in the session’s locale when the node was created.
String	getCreatedBy() Returns the username of the person who created the node.
String	getDescription() Returns the description of the Node.
String	getIdentifier() Returns unique identifier of the node.
GregorianCalendar	getModifiedAt() Gets the modified at.
String	getModifiedBy() Returns the username of the person who modified the node.
String	getName() Returns the name of the node.
String	getPath()
Map<String,Property>	getProperties() Returns a Map of all available properties for the specific node object.
Property	getProperty(String name) Returns the requested property.
<T> T	getPropertyValue(String name) Returns the value of the property with the given name.
String	getTitle() Returns the title of the Node.
String	getType() Returns the type of this Node.
boolean	hasAllowableAction(org.apache.chemistry.opencmis.commons.enums.Action action)
boolean	hasAllowableAction(String action)
boolean	hasAllProperties() Indicates whether the node has all it’s metadata populated.
boolean	hasAspect(String aspectName) Determines if the node has the specified aspect.
boolean	isDocument() Return true if this instance represents a document, false if this represents a folder.
boolean	isFolder() Return true if this instance represents a folder, false if this represents a document.
void	writeToParcel(android.os.Parcel dest, int arg1) Android specific internal methods to save information depending on state.

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<NodeImpl> CREATOR

Android specific internal methods to retrieve information depending on state.
By state it means that

• a node is created by a "cmisobject" so parameter object is not null
  
• if configuration change (orientation screen change...) the parameter object is not saved so become null.
• To save informations (properties, aspects...), Android can use Parcel object that can store important information.

This method is similar as "deserialization" in java world.

Constructor Detail

NodeImpl

public NodeImpl()

NodeImpl

public NodeImpl(org.apache.chemistry.opencmis.client.api.CmisObject o)

Default constructor of a Node based on CMIS service and object.

Parameters:

o -

NodeImpl

public NodeImpl(org.apache.chemistry.opencmis.client.api.CmisObject o,
        boolean hasAllProperties)

Parameters:

o -

Since:

1.2

NodeImpl

public NodeImpl(android.os.Parcel o)

Constructor of a Node object depending of a Parcel object previously created by writeToParcel method.

Parameters:

o - the Parcel object

Method Detail

getIdentifier

public String getIdentifier()

Returns unique identifier of the node.

Specified by:

getIdentifier in interface Node

Returns:

the identifier

getName

public String getName()

Returns the name of the node.

Specified by:

getName in interface Node

Returns:

the name

getTitle

public String getTitle()

Returns the title of the Node.

Specified by:

getTitle in interface Node

Returns:

the title

getDescription

public String getDescription()

Returns the description of the Node.

Specified by:

getDescription in interface Node

Returns:

the description

getType

public String getType()

Returns the type of this Node.

Specified by:

getType in interface Node

Returns:

By default TYPE_CONTENT in document case or TYPE_FOLDER in folder case.
In other cases it returns the specific custom type like my:customdoc

getCreatedBy

public String getCreatedBy()

Returns the username of the person who created the node.

Specified by:

getCreatedBy in interface Node

Returns:

the created by

getCreatedAt

public GregorianCalendar getCreatedAt()

Returns the timestamp in the session’s locale when the node was created.

Specified by:

getCreatedAt in interface Node

Returns:

the created at

getModifiedBy

public String getModifiedBy()

Returns the username of the person who modified the node.

Specified by:

getModifiedBy in interface Node

Returns:

the modified by

getModifiedAt

public GregorianCalendar getModifiedAt()

Gets the modified at.

Specified by:

getModifiedAt in interface Node

Returns:

Returns the timestamp in the session’s locale when the node was modified.

getProperty

public Property getProperty(String name)

Returns the requested property. Use this methods if your property is a multi-value

Specified by:

getProperty in interface Node

Parameters:

name - : unique identifier of your property.

Returns:

Property object.

getProperties

public Map<String,Property> getProperties()

Returns a Map of all available properties for the specific node object.
NB : All property id are CMIS based.

Specified by:

getProperties in interface Node

Returns:

map of properties object

getPropertyValue

public <T> T getPropertyValue(String name)

Returns the value of the property with the given name.

Specified by:

getPropertyValue in interface Node

Parameters:

name - : unique identifier label of the property

Returns:

the property value

hasAspect

public boolean hasAspect(String aspectName)

Determines if the node has the specified aspect.

Specified by:

hasAspect in interface Node

Parameters:

aspectName - : unique identifier of aspect Name.

Returns:

true if the specified aspect is present, false otherwise

getAspects

public List<String> getAspects()

Returns all the aspects applied to the node.

Specified by:

getAspects in interface Node

Returns:

the aspects

hasAllProperties

public boolean hasAllProperties()

Description copied from interface: Node

Indicates whether the node has all it’s metadata populated.

Specified by:

hasAllProperties in interface Node

Returns:

true if all properties are present. False if only general metadata are provided.

isFolder

public boolean isFolder()

Return true if this instance represents a folder, false if this represents a document.

Specified by:

isFolder in interface Node

Returns:

true, if is folder

isDocument

public boolean isDocument()

Return true if this instance represents a document, false if this represents a folder.

Specified by:

isDocument in interface Node

Returns:

true, if is document

hasAllowableAction

public boolean hasAllowableAction(org.apache.chemistry.opencmis.commons.enums.Action action)

Parameters:

action - : cmis type of action like move, delete, create...

Returns:

Returns true if the specific action is allowable

See Also:

Action

hasAllowableAction

public boolean hasAllowableAction(String action)

Parameters:

action - : cmis type of action like move, delete, create...

Returns:

Returns true if the specific action is allowable

See Also:

Action

getAllowableActions

public Set<String> getAllowableActions()

Returns:

Returns a set of all available allowable actions. If no allowable actions available returns an empty collection.

getPath

public String getPath()

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                 int arg1)

Android specific internal methods to save information depending on state.
By state it means that

• a node is created by a "cmisobject" so parameter object is not null
• if configuration change (orientation screen change...) the parameter object is not saved so become null.
• To save informations (properties, aspects...), Android can use Parcel object that can store important information.

This method is similar as "serialization" in java world.

Specified by:

writeToParcel in interface android.os.Parcelable