Detailed Description
Base class for all managed assets.
Definition at line 69 of file fbassetmng.h.
#include <fbassetmng.h>
List of all members.
Public Member Functions |
| FBAssetItem (const char *pName, HIObject pObject=NULL) |
| Constructor.
|
virtual FBString | GetName () const =0 |
| Get the name of this item (file name or folder name).
|
virtual FBString | GetLocalPath () const =0 |
| Get the path to this item on the local hard disk.
|
virtual FBString | GetServerPath () const =0 |
| Get the path to this item on the database.
|
virtual FBAssetFolder * | GetParent () const =0 |
| Get the parent folder of this item.
|
virtual bool | GetLatest (bool pReplaceCheckedOut=false, bool pSilent=false)=0 |
| Obtain the latest version of the item from the server.
|
virtual bool | CheckIn (const FBString &pComment="", bool pKeepCheckedOut=false, bool pSilent=false)=0 |
| Checks in this item and all its children (if this is a folder item).
|
virtual bool | CheckOut (const FBString &pComment="", bool pDontGetLocal=false, bool pSilent=false)=0 |
| Checks out this item and it's childs (if this is a folder item) and makes them writeable on the local disk.
|
virtual bool | UndoCheckOut (bool pReplaceLocalFile=true, bool pSilent=false)=0 |
| Cancel the last check out operation.
|
virtual void | ShowHistory () const =0 |
| Display a dialog with this item history.
|
virtual void | ShowProperties () const =0 |
| Display a dialog showing the properties of this item.
|
Public Attributes |
FBString | LastError |
| Last error string.
|
Constructor & Destructor Documentation
FBAssetItem |
( |
const char * |
pName, |
|
|
HIObject |
pObject = NULL |
|
) |
| |
Constructor.
- Parameters:
-
pName | Name of Command. |
pObject | Internal parent object to own FBComponent (default is NULL). |
Member Function Documentation
virtual FBString GetName |
( |
| ) |
const [pure virtual] |
Get the name of this item (file name or folder name).
- Returns:
- The name of the item, as an FBString.
virtual FBString GetLocalPath |
( |
| ) |
const [pure virtual] |
Get the path to this item on the local hard disk.
- Returns:
- The path as an FBString.
virtual FBString GetServerPath |
( |
| ) |
const [pure virtual] |
Get the path to this item on the database.
- Returns:
- The server path as an FBString.
Get the parent folder of this item.
- Returns:
- An FBAssetFolder* if the parent was found, or NULL if this is the root item.
virtual bool GetLatest |
( |
bool |
pReplaceCheckedOut = false , |
|
|
bool |
pSilent = false |
|
) |
| [pure virtual] |
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.
virtual bool CheckIn |
( |
const FBString & |
pComment = "" , |
|
|
bool |
pKeepCheckedOut = false , |
|
|
bool |
pSilent = false |
|
) |
| [pure virtual] |
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.
virtual bool CheckOut |
( |
const FBString & |
pComment = "" , |
|
|
bool |
pDontGetLocal = false , |
|
|
bool |
pSilent = false |
|
) |
| [pure virtual] |
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.
virtual bool UndoCheckOut |
( |
bool |
pReplaceLocalFile = true , |
|
|
bool |
pSilent = false |
|
) |
| [pure virtual] |
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.
virtual void ShowHistory |
( |
| ) |
const [pure virtual] |
Display a dialog with this item history.
virtual void ShowProperties |
( |
| ) |
const [pure virtual] |
Display a dialog showing the properties of this item.
Member Data Documentation
The documentation for this class was generated from the following file:
FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem
FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem FBAssetItem