Package datafinder :: Package script_api :: Package item :: Module item_description :: Class ItemDescription
[hide private]
[frames] | no frames]

Class ItemDescription

object --+
         |
        ItemDescription

Wrapper around the internal item representation giving restricted access to the relevant parameters. All instance variables are read-only.

Instance Methods [hide private]
 
__init__(self, item)
Constructor.
 
__str__(self)
String representation.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Properties [hide private]
  name
Returns the name of the item.
  path
Returns the path of the item.
  isRoot
Indicates whether it is the root item or not.
  isCollection
Indicates whether it is a collection or not.
  isLeaf
Indicates whether the item is a leaf or not.
  isLink
Indicates whether the item is a link or not.
unicode @see datafinder.core.item.data_persister.constants state
Retrieve the data state associated with NullDataPersister of this item.
  dataUri
Returns the URI of the associated file object.
  uri
Returns the URI of the item.
  isManaged
Flag indicating whether the item belongs to managed repository or not.
  canAddChildren
Convenience method to check whether an item can be created below.
  canDelete
Convenience method to check whether an item can be deleted.
  canCopy
Convenience method to check whether an item can be copied.
  canMove
Convenience method to check whether an item can be moved.
  canStoreData
Convenience method to check whether the associated data can be stored using this item.
  canRetrieveData
Convenience method to check whether the associated data can be retrieved using this item.
  canArchive
Convenience method to check whether an item can be archived.
  canSearch
Convenience method to check whether an item can be searched.
  canRetrieveProperties
Convenience method to check whether an item`s properties can be retrieved.
  canStoreProperties
Convenience method to check whether an item`s properties can be written.

Inherited from object: __class__

Method Details [hide private]

__init__(self, item)
(Constructor)

 

Constructor.

Parameters:
  • item (ItemBase) - The item.
Overrides: object.__init__

__str__(self)
(Informal representation operator)

 

String representation.

Overrides: object.__str__

Property Details [hide private]

name

Returns the name of the item.

Get Method:
unreachable.name(self) - Returns the name of the item.

path

Returns the path of the item.

Get Method:
unreachable.path(self) - Returns the path of the item.

isRoot

Indicates whether it is the root item or not.

Get Method:
unreachable.isRoot(self) - Indicates whether it is the root item or not.

isCollection

Indicates whether it is a collection or not.

Get Method:
unreachable.isCollection(self) - Indicates whether it is a collection or not.

isLeaf

Indicates whether the item is a leaf or not.

Get Method:
unreachable.isLeaf(self) - Indicates whether the item is a leaf or not.

isLink

Indicates whether the item is a link or not.

Get Method:
unreachable.isLink(self) - Indicates whether the item is a link or not.

state

Retrieve the data state associated with NullDataPersister of this item.

Get Method:
unreachable.state(self) - Retrieve the data state associated with NullDataPersister of this item.
Type:
unicode @see datafinder.core.item.data_persister.constants

dataUri

Returns the URI of the associated file object.

Get Method:
unreachable.dataUri(self) - Returns the URI of the associated file object.

uri

Returns the URI of the item.

Get Method:
unreachable.uri(self) - Returns the URI of the item.

isManaged

Flag indicating whether the item belongs to managed repository or not.

Get Method:
unreachable.isManaged(self) - Flag indicating whether the item belongs to managed repository or not.

canAddChildren

Convenience method to check whether an item can be created below.

Get Method:
unreachable.canAddChildren(self) - Convenience method to check whether an item can be created below.

canDelete

Convenience method to check whether an item can be deleted.

Get Method:
unreachable.canDelete(self) - Convenience method to check whether an item can be deleted.

canCopy

Convenience method to check whether an item can be copied.

Get Method:
unreachable.canCopy(self) - Convenience method to check whether an item can be copied.

canMove

Convenience method to check whether an item can be moved.

Get Method:
unreachable.canMove(self) - Convenience method to check whether an item can be moved.

canStoreData

Convenience method to check whether the associated data can be stored using this item.

Get Method:
unreachable.canStoreData(self) - Convenience method to check whether the associated data can be stored using this item.

canRetrieveData

Convenience method to check whether the associated data can be retrieved using this item.

Get Method:
unreachable.canRetrieveData(self) - Convenience method to check whether the associated data can be retrieved using this item.

canArchive

Convenience method to check whether an item can be archived.

Get Method:
unreachable.canArchive(self) - Convenience method to check whether an item can be archived.

canSearch

Convenience method to check whether an item can be searched.

Get Method:
unreachable.canSearch(self) - Convenience method to check whether an item can be searched.

Note: The sanity checks are run again when this method is called.

canRetrieveProperties

Convenience method to check whether an item`s properties can be retrieved.

Get Method:
unreachable.canRetrieveProperties(self) - Convenience method to check whether an item`s properties can be retrieved.

canStoreProperties

Convenience method to check whether an item`s properties can be written.

Get Method:
unreachable.canStoreProperties(self) - Convenience method to check whether an item`s properties can be written.