Public Member Functions | Public Attributes

FBAssetItem Class Reference

Search for all occurrences

Detailed Description

Base class for all managed assets.

Definition at line 69 of file fbassetmng.h.

#include <fbassetmng.h>

Inheritance diagram for FBAssetItem:
Inheritance graph
[legend]

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 FBAssetFolderGetParent () 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:
pNameName of Command.
pObjectInternal 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.
virtual FBAssetFolder* GetParent ( ) const [pure virtual]

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:
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.
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:
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.
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:
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.
virtual bool UndoCheckOut ( bool  pReplaceLocalFile = true,
bool  pSilent = false 
) [pure virtual]

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.
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

Last error string.

Definition at line 139 of file fbassetmng.h.


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