FBAssetItem Class Reference
Detailed Description
Base class for all managed assets.
Inheritance diagram for FBAssetItem:
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.
|
|
| HFBAssetFolder | 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
Constructor.
- Parameters:
-
pName Name of Command. pObject Internal 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.
| HFBAssetFolder GetParent | ( | ) |
Get the parent folder of this item.
- Returns:
- An HFBAssetFolder if the parent was found, or NULL if this is the root item.
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.
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.
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.
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.
| ShowHistory | ( | ) |
Display a dialog with this item history.
| ShowProperties | ( | ) |
Display a dialog showing the properties of this item.
Member Data Documentation
Last error string.
