PPLMetabaseRepositoryObjectDescriptor

The PPLMetabaseRepositoryObjectDescriptor class is used to work with repository object description.

Inheritance Hierarchy

Designer

Syntax

PPLMetabaseRepositoryObjectDescriptor(PPLMetabaseRepositoryDescriptor *repositoryDescriptor)

Parameters

repositoryDescriptor. Repository description.

Example

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

Destructor

Syntax

~PPLMetabaseRepositoryObjectDescriptor()

Comments

The method is intended for internal use.

Methods

Syntax

SNID copy()

Example

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

Syntax

SNString dataSourceRefId() const

Example

OLAP cube or time series database can be used as a data source.

Example

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

dependencies. Returns array of identifiers of repository object descriptions that depend on the current object.

Syntax

SNArray dependencies() const

Example

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

Syntax

SNString description()

Example

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

Syntax

int formatVersion() const

Comments

Object format version determines whether access permissions for this object are taken into account.

Available values:

1. The format, at which report access permissions are taken into account.
2. The format, at which report access permissions are not taken into account.

Example

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

Syntax

long fullSize() const

Comments

If there are dependencies in object description, the method returns size with them.

Example

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

Syntax

SNID generatePlist() const

Example

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

Syntax

NUInteger hash() const

Example

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

hasScreenshot. Checks if an object screenshot is in the corresponding folder on a mobile device.

Syntax

bool hasScreenshot() const

Comments

Available values:

true. Object screenshot is present.
false. Object screenshot is not present.

Example

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

Syntax

bool isDataSource() const

Comments

Available values:

true. Object is a data source.
false. Object is not a data source.

Example

The example of use is given in the Getting of Values of Repository Object Description Properties 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 Object Description section.

Syntax

bool isFolder() const

Comments

Available values:

true. Object is a folder.
false. Object is not a folder.

Example

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

Syntax

bool isHidden() const

Comments

Available values:

true. Object is hidden.
false. Object is visible.

Example

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

Syntax

bool isLocal() const

Comments

Available values:

true. Object is local.
false. Object is not local.

Example

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

Syntax

bool isOutdated() const

Comments

Available values:

true. Object is outdated.
false. Object is not outdated.

Example

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

Syntax

bool isRemote() const

Comments

Available values:

true. Object is remote.
false. Object is not remote.

Example

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

Syntax

bool isReport() const

Comments

Available values:

true. Object is a report.
false. Object is not a report.

Example

The example of use is given in the Data Analysis section.

Syntax

int64 key() const

Example

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

Syntax

SNDate modifiedDate() const

Example

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

Syntax

SNString name() const

Example

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

Syntax

SNString objectId() const

Example

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

obtainScreenshot. Creates an object screenshot in the corresponding folder on a mobile device.

Syntax

SNData obtainScreenshot() const

Comments

The method is under development.

Syntax

SNString parentObjectId() const

Syntax

void setDataSourceRefId(NString *dataSourceRedId)

Parameters

dataSourceRedId. Data source identifier for repository object.

Example

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

setDependencies. Sets array of identifiers of repository object descriptions that depend on the current object.

Syntax

void setDependencies(NArray *dependencies)

Parameters

dependencies. Array of object dependencies.

Example

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

Syntax

void setFormatVersion(int version)

Parameters

version. Object format version. Available values:

1. The format, at which object access permissions are taken into account.
2. The format, at which object access permissions are not taken into account.

Comments

Object format version determines whether access permissions for this object are taken into account.

Example

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

Syntax

void setHidden(bool hidden)

Parameters

hidden. Indicates whether an object is hidden.

Comments

Available values:

true. Object is hidden.
false. Object is visible.

Example

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

Syntax

void setKey(int64 key)

Parameters

key. Object key.

Example

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

Syntax

void setModifiedDate(NDate *modifiedDate)

Parameters

modifiedDate. Change date.

Example

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

Syntax

void setName(NString *name)

Parameters

name. Object 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 Object Description section.

Syntax

void setParentObjectId(NString *objectId)

Parameters

objectId. Parent object identifier.

Example

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

Syntax

void setRepositoryDescriptor(PPLMetabaseRepositoryDescriptor *repositoryDescriptor)

Parameters

repositoryDescriptor. Repository description.

Example

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

setScreenshot. Sets an object screenshot located in the corresponding folder on a mobile device.

Syntax

void setScreenshot(NData *data)

Parameters

data. Object screenshot data.

Comments

The method is under development.

Syntax

void setSize(long size)

Parameters

size. Object size.

Example

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

Syntax

void setType(Type type)

Parameters

type. Object type.

Example

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

Syntax

void setVersion(int64 version)

Parameters

version. Object version.

Example

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

Syntax

long size() const

Example

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

Syntax

Type type() const

Example

The example of use is given in the Data Analysis section.

Syntax

int64 version() const

Example

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

Static Methods

Syntax

static SPPLMetabaseRepositoryObjectDescriptor createObjectDescriptor(PPLMetabaseRepositoryDescriptor *repositoryDescriptor, NDictionary *description)

Parameters

repositoryDescriptor. Repository description

description. Object description.

Comments

The method is under development.

Syntax

static bool isVersionSupported(Type objectType, int formatVersion)

Parameters

objectType. Object type.

formatVersion. Object format version. Available values:

1. Object format version, at which access permissions to this object are taken into account.
2. Object format version, at which access permissions to this object are not taken into account.

Comments

Object format version determines whether access permissions for this object are taken into account.

Available values:

true. The specified object format version is supported.
false. The specified object format version is not supported.

Example

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