Package com.cbe

Class Item

java.lang.Object
com.cbe.Item
Direct Known Subclasses:
Container, Object
public class Item extends Object
A set made up of Container and Object.
Class for an Item.
This is class is the base class of Objects and Containers.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    swigCMemOwn
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Item(long cPtr, boolean cMemoryOwn)
     
    Item(DefaultCtor arg0)
    Conditional comment: Doxygen_Suppress

  • Method Summary

    Modifier and Type
    Method
    Description
    Acl_Map
    aclMap()
    Retrieve the map of the permissions the users and groups for this item.
    String
    aclTag()
    The ACL of the item.
    long
    created()
    Returns the creation date in Unix epoch time.
    long
    databaseId()
    Returns which database number the container resides on.
    boolean
    dataLoaded()
    Check if data was loaded.
    void
    delete()
     
    long
    deleted()
    Returns the deleted date, if applicable (i.e.
    String
    description()
    A item text description, where applicable.
    void
    finalize()
     
    static long
    getCPtr(Item obj)
     
    Publish
    getPublished()
    Gets the publish information
    long
    getShareFromUserId(long userId)
    Get the shareId by reference of userId.
    ShareInfo_Map
    getShareIds()
    A map of share ids for this item.
    Subscribe
    getSubscribe()
    Gets the subscribe information
    long
    getUserFromShareId(long shareId)
    Get the userId reference of shareId.
    boolean
    hasPublished()
    Checks if it has published info and if getPublished() returns a valid object.
    boolean
    hasSubscribe()
    Checks if it has subscribe info and if getSubscribe() returns a valid object.
    long
    id()
    Returns an Items id.
    boolean
    idLoaded()
    if the query did get a resultset.
    String
    name()
    Returns the name of the item.
    long
    oldParentId()
    Returns the id of the Items old parent container id
    in cases where the item has just been moved.
    long
    ownerId()
    Returns the owner id number.
    long
    parentId()
    Returns the id of the Items parent container id.
    String
    path()
    Returns the path if applicable.
    ItemType
    type()
    Container or Object, see enum in Types.h
    long
    updated()
    Returns the updated date/time in Unix epoch time
    String
    username()
    Returns the username of the owner if applicable.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • swigCMemOwn

      protected transient boolean swigCMemOwn

  • Constructor Details

    • Item

      public Item(long cPtr, boolean cMemoryOwn)

    • Item

      public Item(DefaultCtor arg0)
      Conditional comment: Doxygen_Suppress

  • Method Details

    • getCPtr

      public static long getCPtr(Item obj)

    • finalize

      public void finalize()
      Overrides:
      finalize in class Object

    • delete

      public void delete()

    • getShareIds

      public ShareInfo_Map getShareIds()
      A map of share ids for this item.

    • getShareFromUserId

      public long getShareFromUserId(long userId)
      Get the shareId by reference of userId.

    • getUserFromShareId

      public long getUserFromShareId(long shareId)
      Get the userId reference of shareId.

    • aclTag

      public String aclTag()
      The ACL of the item.

    • description

      public String description()
      A item text description, where applicable.

    • id

      public long id()
      Returns an Items id.

    • parentId

      public long parentId()
      Returns the id of the Items parent container id.

    • oldParentId

      public long oldParentId()
      Returns the id of the Items old parent container id
      in cases where the item has just been moved.

    • name

      public String name()
      Returns the name of the item.

    • path

      public String path()
      Returns the path if applicable.

    • ownerId

      public long ownerId()
      Returns the owner id number.

    • databaseId

      public long databaseId()
      Returns which database number the container resides on.

    • username

      public String username()
      Returns the username of the owner if applicable.

    • idLoaded

      public boolean idLoaded()
      if the query did get a resultset.

    • dataLoaded

      public boolean dataLoaded()
      Check if data was loaded.

    • created

      public long created()
      Returns the creation date in Unix epoch time.

    • updated

      public long updated()
      Returns the updated date/time in Unix epoch time

    • deleted

      public long deleted()
      Returns the deleted date, if applicable (i.e. is in the bin), in Unix epoch time

    • type

      public ItemType type()
      Container or Object, see enum in Types.h

    • hasPublished

      public boolean hasPublished()
      Checks if it has published info and if getPublished() returns a valid object.

    • getPublished

      public Publish getPublished()
      Gets the publish information
      See Also:

    • hasSubscribe

      public boolean hasSubscribe()
      Checks if it has subscribe info and if getSubscribe() returns a valid object.

    • getSubscribe

      public Subscribe getSubscribe()
      Gets the subscribe information
      See Also:

    • aclMap

      public Acl_Map aclMap()
      Retrieve the map of the permissions the users and groups for this item.