Jive API (4.5.7.0) Core Javadocs

com.jivesoftware.community
Class ContainerAwareEntityDescriptor

java.lang.Object
  extended by com.jivesoftware.community.EntityDescriptor
      extended by com.jivesoftware.community.ContainerAwareEntityDescriptor
All Implemented Interfaces:
com.jivesoftware.community.ContainerAware, JiveObject, java.io.Serializable

public class ContainerAwareEntityDescriptor
extends EntityDescriptor
implements com.jivesoftware.community.ContainerAware

An entity descriptor that holds information about the container the entity belongs to (if any) at the time of creation.

See Also:
Serialized Form

Field Summary
protected  long containerID
           
protected  int containerType
           
static long EMPTY_CONTAINER_ID
           
static int EMPTY_CONTAINER_TYPE
           
 
Fields inherited from class com.jivesoftware.community.EntityDescriptor
objectID, objectType
 
Constructor Summary
ContainerAwareEntityDescriptor()
          Constructor for serialization use only.
ContainerAwareEntityDescriptor(int objectType, long objectID, long containerID, int containerType)
          Creates a new descriptor given an ID and type.
ContainerAwareEntityDescriptor(JiveObject bean)
          Creates an ContainerAwareEntityDescriptor instance from an existing JiveObject.
 
Method Summary
 boolean equals(java.lang.Object o)
           
 long getContainerID()
           
 int getContainerType()
           
 int hashCode()
           
 java.lang.String toString()
           
 
Methods inherited from class com.jivesoftware.community.EntityDescriptor
getID, getObjectType, getType, isValid
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

EMPTY_CONTAINER_ID

public static final long EMPTY_CONTAINER_ID
See Also:
Constant Field Values

EMPTY_CONTAINER_TYPE

public static final int EMPTY_CONTAINER_TYPE
See Also:
Constant Field Values

containerID

protected long containerID

containerType

protected int containerType
Constructor Detail

ContainerAwareEntityDescriptor

public ContainerAwareEntityDescriptor()
Constructor for serialization use only.


ContainerAwareEntityDescriptor

public ContainerAwareEntityDescriptor(int objectType,
                                      long objectID,
                                      long containerID,
                                      int containerType)
Creates a new descriptor given an ID and type.

Parameters:
objectType - the type of entity (or object) this is. This will be a constant from the JiveConstants class.
objectID - the ID of the entity (or object).
containerType - the type of entity's (or object's) container. This will be a constant from the JiveConstants class.
containerID - the ID of the entity's (or object's) container.

ContainerAwareEntityDescriptor

public ContainerAwareEntityDescriptor(JiveObject bean)
Creates an ContainerAwareEntityDescriptor instance from an existing JiveObject. If the JiveObject is an instance of JiveContentObject or any other object with a container, container information is gathered for it.

Parameters:
bean - The JiveObject to create a ContainerAwareEntityDescriptor for.
Since:
2.5
Method Detail

getContainerID

public long getContainerID()
Specified by:
getContainerID in interface com.jivesoftware.community.ContainerAware

getContainerType

public int getContainerType()
Specified by:
getContainerType in interface com.jivesoftware.community.ContainerAware

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class EntityDescriptor

hashCode

public int hashCode()
Overrides:
hashCode in class EntityDescriptor

toString

public java.lang.String toString()
Overrides:
toString in class EntityDescriptor

Jive Product Page

Copyright © 1999-2007 Jive Software.