Activity (RIF-CS API)

java.lang.Object
- org.ands.rifcs.base.RIFCSElement
- - org.ands.rifcs.base.Activity

```
public class Activity
extends RIFCSElement
```
Class representing a RIF-CS Activity registry object.

Author:

Scott Yeadon

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCoverage(Coverage coverage)` Add a coverage element to the activity object.
`void`	`addDescription(Description description)` Add a description to the activity object.
`void`	`addDescription(java.lang.String description, java.lang.String type, java.lang.String language)` Convenience method to add a description to the activity object.
`void`	`addExistenceDates(ExistenceDates anExistenceDates)` Add an existence dates element to the activity object.
`void`	`addExistenceDates(java.lang.String startVal, java.lang.String startDateFormat, java.lang.String endVal, java.lang.String endDateFormat)` Add an existence dates element to the activity object.
`void`	`addIdentifier(Identifier identifier)` Add an identifier to the activity object.
`void`	`addLocation(Location location)` Add a location to the activity object.
`void`	`addName(Name name)` Add a name to the activity object.
`void`	`addRelatedInfo(RelatedInfo relatedInfo)` Add related info to the activity object.
`void`	`addRelatedObject(RelatedObject relatedObject)` Add a related object to the activity object.
`void`	`addRights(Rights aRights)` Add a rights element to the activity object.
`void`	`addSubject(java.lang.String value, java.lang.String type, java.lang.String termIdentifier, java.lang.String lang)` Add a subject to the activity object.
`void`	`addSubject(Subject subject)` Add a subject to the activity object.
`java.util.List<Coverage>`	`getCoverage()` Obtain the coverage for this activity.
`java.lang.String`	`getDateModified()` return the date modified.
`java.util.List<Description>`	`getDescriptions()` Obtain the description for this activity.
`java.util.List<ExistenceDates>`	`getExistenceDates()` Obtain the description for this activity.
`java.util.List<Identifier>`	`getIdentifiers()` Obtain the identifiers for this activity.
`java.util.List<Location>`	`getLocations()` Obtain the locations for this activity.
`java.util.List<Name>`	`getNames()` Obtain the names for this activity.
`java.util.List<RelatedInfo>`	`getRelatedInfo()` Obtain the related info for this activity.
`java.util.List<RelatedObject>`	`getRelatedObjects()` Obtain the related objects for this activity.
`java.util.List<Rights>`	`getRights()` Obtain the rights for this activity.
`java.util.List<Subject>`	`getSubjects()` Obtain the subjects for this activity.
`java.lang.String`	`getType()` return the type.
`Coverage`	`newCoverage()` Create and return an empty Coverage object.
`Description`	`newDescription()` Create and return an empty Description object.
`ExistenceDates`	`newExistenceDate()` Create and return an empty ExistenceDates object.
`Identifier`	`newIdentifier()` Create and return an empty Identifier object.
`Location`	`newLocation()` Create and return an empty Location object.
`Name`	`newName()` Create and return an empty Name object.
`RelatedInfo`	`newRelatedInfo()` Create and return an empty RelatedInfo object.
`RelatedObject`	`newRelatedObject()` Create and return an empty RelatedObject object.
`Rights`	`newRights()` Create and return an empty Rights object.
`Subject`	`newSubject()` Create and return an empty Subject object.
`void`	`setDateModified(java.util.Date date)` Set the date the activity metadata was modified.
`void`	`setDateModified(java.lang.String date)` Set the date the activity metadata was last modified.
`void`	`setType(java.lang.String type)` Set the type.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setType
```
public final void setType(java.lang.String type)
```
    Set the type.
    
    Parameters:
    type - The type of activity being described
  - getType
```
public final java.lang.String getType()
```
    return the type.
    
    Returns:
    The type attribute value or empty string if attribute is empty or not present
  - setDateModified
```
public final void setDateModified(java.util.Date date)
```
    Set the date the activity metadata was modified.
    
    Parameters:
    date - A date object representing the date the activity metadata was last modified
  - setDateModified
```
public final void setDateModified(java.lang.String date)
```
    Set the date the activity metadata was last modified.
    
    Parameters:
    date - A string in UTC and of one of the forms described in section 3.2.7 of the W3C's Schema Data Types document
  - getDateModified
```
public final java.lang.String getDateModified()
```
    return the date modified.
    
    Returns:
    The dateModified attribute value or empty string if attribute is empty or not present
  - newIdentifier
```
public final Identifier newIdentifier()
                               throws RIFCSException
```
    Create and return an empty Identifier object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.
    
    Returns:
    the new Identifier object
    
    Throws:
    
    RIFCSException - A RIFCSException
  - addIdentifier
```
public final void addIdentifier(Identifier identifier)
```
    Add an identifier to the activity object.
    
    Parameters:
    identifier - an Identifier object
  - getIdentifiers
```
public final java.util.List<Identifier> getIdentifiers()
```
    Obtain the identifiers for this activity.
    
    Returns:
    A list of Identifier objects
  - newName
```
public final Name newName()
                   throws RIFCSException
```
    Create and return an empty Name object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.
    
    Returns:
    the new Name object
    
    Throws:
    
    RIFCSException - A RIFCSException
  - addName
```
public final void addName(Name name)
```
    Add a name to the activity object.
    
    Parameters:
    name - a Name object
  - getNames
```
public final java.util.List<Name> getNames()
```
    Obtain the names for this activity.
    
    Returns:
    List A list of Name objects
  - newLocation
```
public final Location newLocation()
                           throws RIFCSException
```
    Create and return an empty Location object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.
    
    Returns:
    the new Location object
    
    Throws:
    
    RIFCSException - A RIFCSException
  - addLocation
```
public final void addLocation(Location location)
```
    Add a location to the activity object.
    
    Parameters:
    location - a Location object
  - getLocations
```
public final java.util.List<Location> getLocations()
```
    Obtain the locations for this activity.
    
    Returns:
    A list of Location objects
  - newCoverage
```
public final Coverage newCoverage()
                           throws RIFCSException
```
    Create and return an empty Coverage object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.
    
    Returns:
    the new Coverage object
    
    Throws:
    
    RIFCSException - A RIFCSException
  - addCoverage
```
public final void addCoverage(Coverage coverage)
```
    Add a coverage element to the activity object.
    
    Parameters:
    coverage - a Coverage object
  - getCoverage
```
public final java.util.List<Coverage> getCoverage()
```
    Obtain the coverage for this activity.
    
    Returns:
    A list of coverage objects
  - newRelatedObject
```
public final RelatedObject newRelatedObject()
                                     throws RIFCSException
```
    Create and return an empty RelatedObject object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.
    
    Returns:
    the new RelatedObject object
    
    Throws:
    
    RIFCSException - A RIFCSException
  - addRelatedObject
```
public final void addRelatedObject(RelatedObject relatedObject)
```
    Add a related object to the activity object.
    
    Parameters:
    relatedObject - an RelatedObject object
  - getRelatedObjects
```
public final java.util.List<RelatedObject> getRelatedObjects()
```
    Obtain the related objects for this activity.
    
    Returns:
    A list of RelatedObject objects
  - newSubject
```
public final Subject newSubject()
                         throws RIFCSException
```
    Create and return an empty Subject object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.
    
    Returns:
    the new Subject object
    
    Throws:
    
    RIFCSException - A RIFCSException
  - addSubject
```
public final void addSubject(Subject subject)
```
    Add a subject to the activity object.
    
    Parameters:
    subject - a Subject object
  - addSubject
```
public final void addSubject(java.lang.String value,
              java.lang.String type,
              java.lang.String termIdentifier,
              java.lang.String lang)
```
    Add a subject to the activity object.
    
    Parameters:
    value - The value
    type - The type
    termIdentifier - The termIdentifier
    lang - The lang
  - getSubjects
```
public final java.util.List<Subject> getSubjects()
```
    Obtain the subjects for this activity.
    
    Returns:
    A list of Subject objects
  - newDescription
```
public final Description newDescription()
                                 throws RIFCSException
```
    Create and return an empty Description object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.
    
    Returns:
    the new Description object
    
    Throws:
    
    RIFCSException - A RIFCSException
  - addDescription
```
public final void addDescription(Description description)
```
    Add a description to the activity object.
    
    Parameters:
    description - a Description object
  - addDescription
```
public final void addDescription(java.lang.String description,
                  java.lang.String type,
                  java.lang.String language)
                          throws RIFCSException
```
    Convenience method to add a description to the activity object.
    
    Parameters:
    description - a description string
    type - the description type
    language - the description language or null
    
    Throws:
    
    RIFCSException - A RIFCSException
  - getDescriptions
```
public final java.util.List<Description> getDescriptions()
```
    Obtain the description for this activity.
    
    Returns:
    A list of Description objects
  - newRights
```
public final Rights newRights()
                       throws RIFCSException
```
    Create and return an empty Rights object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.
    
    Returns:
    the new Rights object
    
    Throws:
    
    RIFCSException - A RIFCSException
  - addRights
```
public final void addRights(Rights aRights)
```
    Add a rights element to the activity object.
    
    Parameters:
    aRights - a Rights object
  - getRights
```
public final java.util.List<Rights> getRights()
```
    Obtain the rights for this activity.
    
    Returns:
    A list of Rights objects
  - newExistenceDate
```
public final ExistenceDates newExistenceDate()
                                      throws RIFCSException
```
    Create and return an empty ExistenceDates object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.
    
    Returns:
    the new ExistenceDates object
    
    Throws:
    
    RIFCSException - A RIFCSException
  - addExistenceDates
```
public final void addExistenceDates(ExistenceDates anExistenceDates)
```
    Add an existence dates element to the activity object.
    
    Parameters:
    anExistenceDates - an ExistenceDates object
  - addExistenceDates
```
public final void addExistenceDates(java.lang.String startVal,
                     java.lang.String startDateFormat,
                     java.lang.String endVal,
                     java.lang.String endDateFormat)
```
    Add an existence dates element to the activity object.
    
    Parameters:
    startVal - The start date
    startDateFormat - The start date format
    endVal - The end date
    endDateFormat - The end date format
  - getExistenceDates
```
public final java.util.List<ExistenceDates> getExistenceDates()
```
    Obtain the description for this activity.
    
    Returns:
    A list of Description objects
  - newRelatedInfo
```
public final RelatedInfo newRelatedInfo()
                                 throws RIFCSException
```
    Create and return an empty RelatedInfo object. The returned object has no properties or content and is not part of the RIF-CS document, it is essentially a constructor of an object owned by the RIF-CS document. The returned object needs to be "filled out" (e.g. with properties, additional sub-elements, etc) before being added to the RIF-CS document.
    
    Returns:
    the new RelatedInfo object
    
    Throws:
    
    RIFCSException - A RIFCSException
  - addRelatedInfo
```
public final void addRelatedInfo(RelatedInfo relatedInfo)
```
    Add related info to the activity object.
    
    Parameters:
    relatedInfo - a relatedInfo object
  - getRelatedInfo
```
public final java.util.List<RelatedInfo> getRelatedInfo()
```
    Obtain the related info for this activity.
    
    Returns:
    List A list of RelatedInfo objects

Class Activity

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setType

getType

setDateModified

setDateModified

getDateModified

newIdentifier

addIdentifier

getIdentifiers

newName

addName

getNames

newLocation

addLocation

getLocations

newCoverage

addCoverage

getCoverage

newRelatedObject

addRelatedObject

getRelatedObjects

newSubject

addSubject

addSubject

getSubjects

newDescription

addDescription

addDescription

getDescriptions

newRights

addRights

getRights

newExistenceDate

addExistenceDates

addExistenceDates

getExistenceDates

newRelatedInfo

addRelatedInfo

getRelatedInfo