FBAssetItem Class Reference


Detailed Description

Base class for all managed assets.

Inheritance diagram for FBAssetItem:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
str GetName ()
 Get the name of this item (file name or folder name).
str GetLocalPath ()
 Get the path to this item on the local hard disk.
str GetServerPath ()
 Get the path to this item on the database.
FBAssetFolder GetParent ()
 Get the parent folder of this item.
bool GetLatest (bool pReplaceCheckedOut=False, bool pSilent=False)
 Obtain the latest version of the item from the server.
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 UndoCheckOut (bool pReplaceLocalFile=True, bool pSilent=False)
 Cancel the last check out operation.
 ShowHistory ()
 Display a dialog with this item history.
 ShowProperties ()
 Display a dialog showing the properties of this item.

Public Attributes

str LastError
 Last error string.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

Parameters:
pNameName of Command.
pObjectInternal parent object to own FBComponent (default is NULL).

Reimplemented in FBAssetFile, and FBAssetFolder.

str GetName ( )

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

Returns:
The name of the item, as an FBString.
str GetLocalPath ( )

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

Returns:
The path as an FBString.
str GetServerPath ( )

Get the path to this item on the database.

Returns:
The server path as an FBString.
FBAssetFolder GetParent ( )

Get the parent folder of this item.

Returns:
An FBAssetFolder* if the parent was found, or NULL if this is the root item.
bool GetLatest ( bool  pReplaceCheckedOut = False,
bool  pSilent = False 
)

Obtain the latest version of the item from the server.

Parameters:
pReplaceCheckedOutWhether to replace the checked out file or not.
pSilentIf pSilent is set to true, no dialog will be displayed by this method.
Returns:
A boolean indicating if the operation was successful.
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:
pCommentComment to be applied for the check in.
pKeepCheckedOutFlag that indicates whether the item will be kept checked out.
pSilentIf 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:
pCommentComment to be applied for the check out.
pDontGetLocalIndicate if local copy should retrieved or not.
pSilentIf pSilent is set to true, no dialog will be displayed by this method.
Returns:
A boolean indicating if the operation was successful.
bool UndoCheckOut ( bool  pReplaceLocalFile = True,
bool  pSilent = False 
)

Cancel the last check out operation.

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

Display a dialog with this item history.

ShowProperties ( )

Display a dialog showing the properties of this item.


Member Data Documentation


FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem
FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem