org.alfresco.bm.dataload.rm.services

Class FilePlanData

java.lang.Object

org.alfresco.bm.dataload.rm.services.FilePlanData

All Implemented Interfaces:

Serializable

public class FilePlanData
extends Object
implements Serializable

File plan data to serialize / deserialize to/from MongoDB.

Since:

2.6

Author:

Frank Becker

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FilePlanData() Constructor

Method Summary

Modifier and Type	Method and Description
org.alfresco.bm.data.DataCreationState	getCreationState() Gets the creation state.
String	getName() Returns the name of the file plan
String	getPlanType() Returns the type of the plan - always "rma:filePlan" or a sub-type.
FilePlanData	setCreationState(org.alfresco.bm.data.DataCreationState creationState) Sets the creation state of the file plan in MongoDB.
FilePlanData	setName(String name) Sets the name of the file plan.
FilePlanData	setPlanType(String value) Sets the file plan type - always "rma:filePlan" or a sub-type.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePlanData

public FilePlanData()

Constructor

Method Detail

getName

public String getName()

Returns the name of the file plan

Returns:

(String)the name of the file plan

setName

public FilePlanData setName(String name)

Sets the name of the file plan.

Parameters:

name - (String) name of the file plan (required).

Returns:

this.

getCreationState

public org.alfresco.bm.data.DataCreationState getCreationState()

Gets the creation state.

Returns:

(DataCreationState) state of file plan in MongoDB.

setCreationState

public FilePlanData setCreationState(org.alfresco.bm.data.DataCreationState creationState)

Sets the creation state of the file plan in MongoDB.

Parameters:

creationState - (DataCreationState)state to set.

Returns:

this.

getPlanType

public String getPlanType()

Returns the type of the plan - always "rma:filePlan" or a sub-type.

Returns:

(String) the type of the plan - always "rma:filePlan" or a sub-type.

setPlanType

public FilePlanData setPlanType(String value)

Sets the file plan type - always "rma:filePlan" or a sub-type.

Parameters:

value - (String) value to set.

Returns:

this

toString

public String toString()

Overrides:

toString in class Object