PPLMetabaseRepositoryDescriptor

Syntax

PPLMetabaseRepositoryDescriptor()

Example

The example of use is given in the Working with Repository Object Description section.

Syntax

~PPLMetabaseRepositoryDescriptor()

Comments

The method is intended for internal use.

Syntax

void addFavoriteObject(PPLMetabaseRepositoryFavoriteDescriptor *descriptor)

Parameters

descriptor. Description of favorite repository object.

Example

The example of use is given in the Working with Repository section.

Syntax

void addLocalObject(PPLMetabaseRepositoryObjectDescriptor *descriptor)

Parameters

descriptor. Repository object description.

Example

The example of use is given in the Working with Repository section.

Syntax

SPPLMetabaseRepositoryFavoriteDescriptor addObjectToFavorite(PPLMetabaseRepositoryObjectDescriptor *descriptor,

NString *name, bool hidden)

Parameters

descriptor. Repository object description.

name. Object name for favorites.

hidden. Indicates whether object should be added to favorites. Available values:

• true. Object should not be added to favorites.

• false. Object should be added to favorites (default).

Example

The example of use is given in the Working with Favorite Object section.

Syntax

void addOutdatedObject(PPLMetabaseRepositoryObjectDescriptor *descriptor)

Parameters

descriptor. Repository object description.

Example

The example of use is given in the Working with Repository section.

Syntax

void addRemoteObject(PPLMetabaseRepositoryObjectDescriptor *descriptor)

Parameters

descriptor. Repository object description.

Example

The example of use is given in the Working with Repository section.

Syntax

SNArray allObjects() const

Example

The example of use is given in the Getting of Values of Repository Object Description Properties section.

Syntax

SNString description()

Example

The example of use is given in the Working with Repository section.

Syntax

SNArray favoriteObjects() const

Example

The example of use is given in the Working with Repository section.

Syntax

SNString generateFavoriteName(NString *suggestedName) const

Parameters

suggestedName. Suggested name.

Example

The example of use is given in the Working with Repository section.

Syntax

int64 generateNewObjectKey() const

Example

The example of use is given in the Working with Repository section.

Syntax

SNID generatePlist() const

Example

The example of use is given in the Working with Repository section.

Syntax

SPPLMetabaseRepositoryFavoriteDescriptor getFavoriteObjectByObjectId(NString *objectId) const

Parameters

objectId. Object identifier.

Example

The example of use is given in the Working with Repository section.

Syntax

SPPLMetabaseRepositoryObjectDescriptor getLocalObjectByObjectId(NString *objectId) const

Parameters

objectId. Object identifier.

Example

The example of use is given in the Working with Repository section.

Syntax

SPPLMetabaseRepositoryObjectDescriptor getLocalObjectByObjectKey(int64 objectKey) const

Parameters

objectKey. Object key.

Example

The example of use is given in the Working with Repository section.

Syntax

SPPLMetabaseRepositoryObjectDescriptor getRemoteObjectByObjectId(NString *objectId) const

Parameters

objectId. Object identifier.

Example

The example of use is given in the Working with Repository section.

Syntax

NUInteger hash() const

Example

The example of use is given in the Working with Repository section.

Syntax

SNString host() const

Example

The example of use is given in the Working with Repository section.

Syntax

bool isEqual(NID object)

Parameters

object. Object for comparison.

Comments

Available values:

• true. Objects are equal.

• false. Objects are not equal.

Example

The example of use is given in the Working with Repository section.

Syntax

bool isObjectLocal(const PPLMetabaseRepositoryObjectDescriptor *objectDescriptor) const

Parameters

objectDescriptor. Object description.

Comments

Available values:

• true. Object is local.

• false. Object is not local.

Example

The example of use is given in the Working with Repository section.

Syntax

bool isObjectOutdated(const PPLMetabaseRepositoryObjectDescriptor *objectDescriptor) const

Parameters

objectDescriptor. Object description.

Comments

Available values:

• true. Object is outdated.

• false. Object is not outdated.

Example

The example of use is given in the Working with Repository section.

Syntax

bool isObjectRemote(const PPLMetabaseRepositoryObjectDescriptor *objectDescriptor) const

Parameters

objectDescriptor. Object description.

Comments

Available values:

• true. Object is remote.

• false. Object is not remote.

Example

The example of use is given in the Working with Repository section.

Syntax

int64 key() const

Example

The example of use is given in the Working with Repository section.

Syntax

SNArray localObjects() const

Example

The example of use is given in the Working with Repository section.

Syntax

void merge(PPLMetabaseRepositoryDescriptor *otherDescriptor)

Parameters

otherDescriptor. Repository description.

Example

The example of use is given in the Working with Repository section.

Syntax

SNString mobileAppName() const

Example

The example of use is given in the Working with Repository Object Description section.

Syntax

void moveObjectToLocal(PPLMetabaseRepositoryObjectDescriptor *descriptor)

Parameters

descriptor. Repository object description.

Example

The example of use is given in the Working with Repository section.

Syntax

void moveObjectToRemote(PPLMetabaseRepositoryObjectDescriptor *descriptor)

Parameters

descriptor. Repository object description.

Example

The example of use is given in the Working with Repository section.

Syntax

SNString objectId() const

Example

The example of use is given in the Working with Repository section.

Syntax

SNArray outdatedObjects() const

Example

The example of use is given in the Working with Repository section.

Syntax

void registerNewObjectDescriptor(PPLMetabaseRepositoryObjectDescriptor *descriptor)

Parameters

descriptor. Object description.

Example

The example of use is given in the Working with Repository section.

Syntax

SNArray remoteObjects() const

Example

The example of use is given in the Working with Repository section.

Syntax

void removeFavorite(PPLMetabaseRepositoryFavoriteDescriptor *descriptor)

Parameters

descriptor. Description of favorite repository object.

Example

The example of use is given in the Working with Repository section.

Syntax

void removeObject(PPLMetabaseRepositoryObjectDescriptor *descriptor)

Parameters

descriptor. Repository object description.

Example

The example of use is given in the Working with Repository section.

Syntax

void setHost(NString *host)

Parameters

host. Web address.

Example

The example of use is given in the Working with Repository section.

Syntax

void setKey(int64 key)

Parameters

key. Repository key.

Example

The example of use is given in the Working with Repository section.

Syntax

void setMobileAppName(NString *mobileAppName)

Parameters

mobileAppName. Mobile application name.

Example

The example of use is given in the Working with Repository Object Description section.

Syntax

void setObjectId(NString *objectId)

Parameters

objectId. Object identifier.

Example

The example of use is given in the Working with Repository section.

Syntax

void setSourceURL(NString *sourceURL)

Parameters

sourceURL. Repository source web address.

Example

The example of use is given in the Working with Repository section.

Syntax

void setVersion(int64 version)

Parameters

version. Repository version.

Example

The example of use is given in the Working with Repository section.

Syntax

void setWebAppName(NString *webAppName)

Parameters

webAppName. Web application name.

Example

The example of use is given in the Working with Repository section.

Syntax

SNString sourceURL() const

Example

The example of use is given in the Working with Repository section.

Syntax

int64 version() const

Example

The example of use is given in the Working with Repository section.

Syntax

SNString webAppName() const

Example

The example of use is given in the Working with Repository section.

Syntax

static SNString generateUrlBasedKey(NString *host, NString *webAppName, NString *mobileAppName)

Parameters

host. Repository web address.

webAppName. Web application name.

mobileAppName. Mobile application name.

Example

The example of use is given in the Working with Repository section.

Syntax

static SPPLMetabaseRepositoryDescriptor repositoryDescriptor(NString *dirPath)

Parameters

dirPath. A path to the directory with repository settings file.

Example

The example of use is given in the Working with Repository section.

Syntax

static SPPLMetabaseRepositoryDescriptor repositoryDescriptor(NString *dirPath, NString *sourceUrl)

Parameters

dirPath. A path to the directory with a mobile applications settings file.

sourceUrl. The address, at which a mobile application settings file is available.

Example

The example of use is given in the Working with Repository section.