API - ActivitySeries

The ActivitySeries abstract class represents a series of related activities.

Fields

Field	Type	Description
id	String	Unique identifier
typeName	String	Series type name
name	String	Series name
begin	ZonedDateTime	Series start date
end	ZonedDateTime	Series end date
locationName	String	Series location
projectName	String	Associated project
requestorName	String	Requestor name
attributes	List<Attribute>	Associated attributes
attributeGroups	List<AttributeGroup>	Attribute groups
activities	List<Activity>	Member activities

Getters

/**
 * the technical UUID of tha activity
 */
String getId();

/**
 *
 * The name (former Manual ID) of the activity type
 */
String getTypeName();

/**
 *
 * @return The name of the activity.  
 */
String getName();

/**
 *
 * @return the name of the project the activity is assigned to. 
 *         If the activity is not assigned to a project than null is returned.
 */
String getProjectName();

/**
 *
 * @return the login name of the user who requested the activity. 
 *         If the activity is not requested by a user than null is returned.
 */
String getRequestorName();

/**
 *
 * @return the name (former mmanual id) of the location the activity is assigned to.
 */
String getLocationName();

/**
 *
 * @param locationName the name of the location (former manual id) to assign the activity to. 
 *                     The location needs to be defined by the administrator.
 * @throws DataAccessException
 */
void setLocation(String locationName) throws DataAccessException;

/**
 * Sets the name of the activity. If administrator has set a display name attribute 
 * method will raise error
 * @param name the name of the activity to be set. 
 * @throws DataAccessException
 */
void setName(String name) throws DataAccessException;

/**
 *  Sets the login name of the user who requested the activity. The user needs to 
 *  be defined by the administrator.
 * @param loginName the login name of the user who requested the activity.
 * @throws DataAccessException
 */
void setRequestor(String loginName) throws DataAccessException;

Methods for dynamic attributes

/**
 * @return Attributes as defined by the administrator and 
 * static fields referred by {@link StaticAttribute}
 */
List<Attribute> getAttributes();

/**
 * 
 * @return Attribute groups as defined by the administrator 
 * */
List<AttributeGroup> getAttributeGroups();

Methods for timing and scheduling

/**
 *
 * @return begin of the activity
 */
ZonedDateTime getBegin();

/**
 *
 * @return end of the activity
 */
ZonedDateTime getEnd();


/**
 * @deprecated use {@link #setStart(ZonedDateTime)}
 * @param begin New begin
 */
public void setBegin(ZonedDateTime begin);

/**
 * @param start New start
 */
public void setStart(ZonedDateTime start);

/**
 * @param end New end
 */
public void setEnd(ZonedDateTime end);

Methods for resource assignments

/**
 * @return list of resources assigned to the activity
 */
List<Resource> getResourceAssignments();

Methods for included activities

/**
 * 
 * @return Ordered list of activities included in the series.
 */
List<Activity> getActivities();