FBAssetItem Class Reference

FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem
Inheritance diagram for FBAssetItem:
Inheritance graph
[legend]

List of all members.


Detailed Description

Base class for all managed assets.

Public Member Functions

  FBAssetItem (str pName)
  Constructor.
bool  CheckIn (str pComment="", bool pKeepCheckedOut=False, bool pSilent=False)
  Checks in this item and all its children (if this is a folder item).
bool  CheckOut (str pComment="", bool pDontGetLocal=False, bool pSilent=False)
  Checks out this item and it's childs (if this is a folder item) and makes them writeable on the local disk.
bool  GetLatest (bool pReplaceCheckedOut=False, bool pSilent=False)
  Obtain the latest version of the item from the server.
str  GetLocalPath ()
  Get the path to this item on the local hard disk.
str  GetName ()
  Get the name of this item (file name or folder name).
FBAssetFolder  GetParent ()
  Get the parent folder of this item.
str  GetServerPath ()
  Get the path to this item on the database.
  ShowHistory ()
  Display a dialog with this item history.
  ShowProperties ()
  Display a dialog showing the properties of this item.
bool  UndoCheckOut (bool pReplaceLocalFile=True, bool pSilent=False)
  Cancel the last check out operation.

Public Attributes

str  LastError
  Last error string.

Constructor & Destructor Documentation

FBAssetItem ( str  pName  ) 

Constructor.

Parameters:
pName  Name of Command.

Member Function Documentation

bool CheckIn ( str  pComment = "",
bool  pKeepCheckedOut = False,
bool  pSilent = False  
)

Checks in this item and all its children (if this is a folder item).

Parameters:
pComment  Comment to be applied for the check in.
pKeepCheckedOut  Flag that indicates whether the item will be kept checked out.
pSilent  If pSilent is set to true, no dialog will be displayed by this method.
Returns:
A boolean indicating if the operation was successful.

bool CheckOut ( str  pComment = "",
bool  pDontGetLocal = False,
bool  pSilent = False  
)

Checks out this item and it's childs (if this is a folder item) and makes them writeable on the local disk.

Parameters:
pComment  Comment to be applied for the check out.
pDontGetLocal  Indicate if local copy should retrieved or not.
pSilent  If pSilent is set to true, no dialog will be displayed by this method.
Returns:
A boolean indicating if the operation was successful.

bool GetLatest ( bool  pReplaceCheckedOut = False,
bool  pSilent = False  
)

Obtain the latest version of the item from the server.

Parameters:
pReplaceCheckedOut  Whether to replace the checked out file or not.
pSilent  If pSilent is set to true, no dialog will be displayed by this method.
Returns:
A boolean indicating if the operation was successful.

str GetLocalPath (  ) 

Get the path to this item on the local hard disk.

Returns:
The path as an FBString.

str GetName (  ) 

Get the name of this item (file name or folder name).

Returns:
The name of the item, as an FBString.

FBAssetFolder GetParent (  ) 

Get the parent folder of this item.

Returns:
An HFBAssetFolder if the parent was found, or NULL if this is the root item.

str GetServerPath (  ) 

Get the path to this item on the database.

Returns:
The server path as an FBString.

ShowHistory (  ) 

Display a dialog with this item history.

ShowProperties (  ) 

Display a dialog showing the properties of this item.

bool UndoCheckOut ( bool  pReplaceLocalFile = True,
bool  pSilent = False  
)

Cancel the last check out operation.

Parameters:
pReplaceLocalFile  Flag indicating if the local item(s) should be replaced by the server version.
pSilent  If pSilent is set to true, no dialog will be displayed by this method.
Returns:
A boolean indicating if the operation was successful.

Member Data Documentation

str LastError

Last error string.


Generated on Tue Feb 9 19:34:09 2010 for Python Reference Guide by  doxygen 1.5.3