Container (AR System Java API)

java.lang.Object
- com.bmc.arsys.api.ObjectBase
- - com.bmc.arsys.api.Container

All Implemented Interfaces:

IARPersistentObject, Serializable, Cloneable

Direct Known Subclasses:

ActiveLinkGuide, ApplicationContainer, FilterGuide, PackingList, WebService
```
public abstract class Container
extends ObjectBase
implements Cloneable, Serializable
```
Class and methods for container object. Containers are generic lists of references that are used to define guides and applications.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Container()
construct an empty container instance

Constructors
Constructor and Description
`Container()` construct an empty container instance

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()` AR System reserved method.
`void`	`clear()` Clears all of the references to member objects.
`Object`	`clone()` Clone implementation that returns an Object with data cloned from self.
`boolean`	`equals(Object obj)` Use this method for checking equality between the current object and the provided one.
`List<Integer>`	`getAdminGroupList()` Returns list of zero or more groups who can administer this container (and the referenced objects).
`List<PermissionInfo>`	`getAssignedGroup()` get list of assigned group
`List<ContainerOwner>`	`getContainerOwner()` Returns the form that owns this container.
`String`	`getDescription()` Returns description for this container.
`String`	`getKey()` Returns unique identifier (name) for container.
`String`	`getLabel()` Returns label for this container.
`ObjectPropertyMap`	`getProperties()` Returns object properties list associated with the container.
`List<Reference>`	`getReferences()` Returns a list of pointers to the objects referenced by this container.
`int`	`getType()` Returns the type for this container, either guide (`ARCON_GUIDE`), application (`ARCON_APP`), or a custom type you have defined.
`int`	`hashCode()` Returns the hash code value for this instance of the current class.
`void`	`passivate()` AR System reserved method.
`void`	`removeReferenceByObject(Reference object)` Removes a reference from the reference list by comparing the objects using ==.
`void`	`setAdminGroupList(List<Integer> adminList)` Sets list of zero or more groups who can administer this container (and the referenced objects).
`void`	`setContainerOwner(List<ContainerOwner> owner)` Sets the form that owns this container.
`void`	`setDescription(String desc)` Sets description for this container.
`void`	`setKey(String key)` Sets unique identifier (name) for container.
`void`	`setLabel(String label)` Sets label for this container.
`void`	`setPermissions(List<PermissionInfo> permissionList)` Sets a list of zero or more groups who can access this container
`void`	`setProperties(ObjectPropertyMap props)` Sets object properties list associated with the container.
`void`	`setReferences(List<Reference> refs)` Sets a list of pointers to the objects referenced by this container.
`String`	`toString()` Returns a string description of the object.

Methods inherited from class com.bmc.arsys.api.ObjectBase
appendDiaryText, getChangeFlags, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setChangeFlags, setDiary, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner

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

- Constructor Detail
  - Container
```
public Container()
```
    construct an empty container instance
- Method Detail
  - getKey
```
public String getKey()
```
    Returns unique identifier (name) for container.
  - setKey
```
public void setKey(String key)
```
    Sets unique identifier (name) for container.
  - setAdminGroupList
```
public void setAdminGroupList(List<Integer> adminList)
```
    Sets list of zero or more groups who can administer this container (and the referenced objects). If ownerObj is not NULL, this parameter is ignored and the Subadministrator group list of the owning form is used instead. Users must belong to both a specified group and the Subadministrator group to obtain these privileges. Specifying an empty administrator group list defines a container that can be administered by users with administrator capability only. Specifying group ID 0 (Public) provides subadministrator capability to all members of the Subadministrator group.
    
    Parameters:
    
    adminList - An array of int objects
  - getAdminGroupList
```
public List<Integer> getAdminGroupList()
```
    Returns list of zero or more groups who can administer this container (and the referenced objects).
  - setPermissions
```
public void setPermissions(List<PermissionInfo> permissionList)
```
    Sets a list of zero or more groups who can access this container
    
    Specified by:
    
    setPermissions in interface IARPersistentObject
    
    Overrides:
    
    setPermissions in class ObjectBase
  - setLabel
```
public void setLabel(String label)
```
    Sets label for this container.
  - getLabel
```
public String getLabel()
```
    Returns label for this container.
  - setDescription
```
public void setDescription(String desc)
```
    Sets description for this container.
  - getDescription
```
public String getDescription()
```
    Returns description for this container.
  - getType
```
public int getType()
```
    Returns the type for this container, either guide (ARCON_GUIDE), application (ARCON_APP), or a custom type you have defined.
  - setReferences
```
public void setReferences(List<Reference> refs)
```
    Sets a list of pointers to the objects referenced by this container. References can be to internal AR System objects (for example, guides reference active links and applications reference forms) or to ExternalReference external objects such as URLs or file names.
  - getReferences
```
public List<Reference> getReferences()
```
    Returns a list of pointers to the objects referenced by this container. References can be to internal AR System objects (for example, guides reference active links and applications reference forms) or to ExternalReference external objects such as URLs or file names.
  - setContainerOwner
```
public void setContainerOwner(List<ContainerOwner> owner)
```
    Sets the form that owns this container. Specify NULL for this parameter if you want the container to exist globally.
    
    Parameters:
    
    owner - ContainerOwner
  - getContainerOwner
```
public List<ContainerOwner> getContainerOwner()
```
    Returns the form that owns this container.
  - setProperties
```
public void setProperties(ObjectPropertyMap props)
```
    Sets object properties list associated with the container. If set to NULL, no object properties list with zero properties will be associated with the container. You can specify the following server object property tags. The following constant values are defined by AR System.
    - AR_OPROP_VENDOR_NAME: (CHAR): Indicates the vendor name. For example, " BMC Software."
    - AR_OPROP_VENDOR_PRODUCT: (CHAR): Indicates the product name. For example, " AR System."
    - AR_OPROP_VENDOR_VERSION: (CHAR): Indicates the vendor version. For example, " 6.0."
    - AR_OPROP_GUID: (CHAR): Indicates the globally unique identifier for the object.
    - AR_OPROP_COPYRIGHT: (CHAR): Indicates the copyright string.
    - AR_OPROP_SCC_LOCKED_BY:(CHAR): Indicates the name of user who has locked the object.
    - AR_OPROP_SCC_VERSION: (CHAR): Indicates the version of the Source Code Control (SCC) system.
    - AR_OPROP_SCC_TIMESTAMP: (TIME): Indicates the SCC timestamp.
    - AR_OPROP_SCC_USER: (CHAR): Indicates the SCC username.
    - AR_OPROP_SCC_LOCATION: (CHAR): Indicates the location within the SCC system where the object may be found.
    - AR_OPROP_SCC_DATA_LOCKED_BY: (CHAR): Indicates the name of the user who has "locked" the data or entries stored in a form under revision control. The AR System server does not enforce this lock and thus it is to be considered an advisory lock only.
    - AR_OPROP_SCC_DATA_VERSION: (CHAR): Indicates the SCC version of the data or entries stored in a form under revision control.
    - AR_OPROP_SCC_DATA_TIMESTAMP: (CHAR): Indicates the SCC timestamp of the data or entries stored in a form under revision control.
    - AR_OPROP_SCC_DATA_USER : (TIME): Indicates the SCC username for the data or entries stored in a form under revision control.
    - AR_OPROP_SCC_DATA_LOCATION: (CHAR): Indicates the location within the SCC system where the data or entries stored in a form under revision control.
    If getProperties parameter is NULL, a list of zero properties is returned.
  - getProperties
```
public ObjectPropertyMap getProperties()
```
    Returns object properties list associated with the container. If set to NULL, a list of zero properties is returned.
  - clear
```
public void clear()
```
    Clears all of the references to member objects.
    
    Overrides:
    
    clear in class ObjectBase
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Clone implementation that returns an Object with data cloned from self.
    
    Overrides:
    
    clone in class ObjectBase
    
    Throws:
    
    CloneNotSupportedException
  - activate
```
public void activate()
```
    AR System reserved method.
  - passivate
```
public void passivate()
```
    AR System reserved method.
  - equals
```
public boolean equals(Object obj)
```
    Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.
    
    Overrides:
    
    equals in class ObjectBase
    
    Parameters:
    
    obj - the object that we are comparing to
    
    Returns:
    
    returns a boolean that tells if the two objects equal
  - hashCode
```
public int hashCode()
```
    Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.
    
    Overrides:
    
    hashCode in class ObjectBase
    
    Returns:
    
    returns the hash code for this instance
  - toString
```
public String toString()
```
    Returns a string description of the object.
    
    Overrides:
    
    toString in class ObjectBase
  - removeReferenceByObject
```
public void removeReferenceByObject(Reference object)
```
    Removes a reference from the reference list by comparing the objects using ==. Use this instead of getReferences().remove(Object o), since getReferences().remove(Object o) will remove the first matching reference in the list, which can lead to data corruption. See the documentation for java.util.List for why it should not be used to remove references
    
    Parameters:
    
    object - Reference to remove from the list
  - getAssignedGroup
```
public List<PermissionInfo> getAssignedGroup()
```
    get list of assigned group
    
    Returns:
    
    list of assigned group

Class Container

Constructor Summary

Method Summary

Methods inherited from class com.bmc.arsys.api.ObjectBase

Methods inherited from class java.lang.Object

Constructor Detail

Container

Method Detail

getKey

setKey

setAdminGroupList

getAdminGroupList

setPermissions

setLabel

getLabel

setDescription

getDescription

getType

setReferences

getReferences

setContainerOwner

getContainerOwner

setProperties

getProperties

clear

clone

activate

passivate

equals

hashCode

toString

removeReferenceByObject

getAssignedGroup