Skip to main content

ERUCES::TETemplatedDirectory

#include <tetemplateddirectory.h>

The TETemplatedDirectory class represents a templated directory.

Inheritance

Public Types

enum TEMPLATED_DIRECTORY_FLAG

The TEMPLATED_DIRECTORY_FLAG enum sets the directory flag.

ValueDescription
ENABLEEnable the directory.
DISABLEDisable the directory.

Public Member Functions

MemberDescription
TETemplatedDirectory()The TETemplatedDirectory constructor is the default class constructor.
TETemplatedDirectory(const TETemplatedDirectory &)The TETemplatedDirectory constructor copies a TETemplatedDirectory object.
~TETemplatedDirectory()The TETemplatedDirectory destructor is the class destructor.
void setId(te_oid id)The setId method sets the templated directory's unique ID.
te_oid getId() constThe getId method retrieves the templated directory's unique ID.
void setHostId(te_oid id)The setHostId method sets the templated directory's host ID.
te_oid getHostId() constThe getHostId method retrieves the templated directory's unique ID.
void setPath(const _TESTD string &path)The setPath method sets the templated directory path.
const _TESTD string getPath() constThe getPath method retrieves the templated directory path.
void setAlias(const _TESTD string &alias)The setAlias method sets the templated directory path's alias.
const _TESTD string getAlias() constThe getAlias method retrieves the templated directory path's alias.
void setAclTemplateId(te_oid id)The setAclTemplateId sets the ACL's unique Template ID.
te_oid getAclTemplateId() constThe getAclTemplateId retrieves the ACL's unique Template ID.
void setFlag(uint32_t flag)The setFlag method sets flag.
uint32_t getFlag() constThe getFlag method retrieves the flag.
TEObject * clone() constThe clone method clones a TETemplatedDirectory object.

Member Function Documentation

TETemplatedDirectory()

The TETemplatedDirectory constructor is the default class constructor.

TETemplatedDirectory(const TETemplatedDirectory &)

The TETemplatedDirectory constructor copies a TETemplatedDirectory object.

~TETemplatedDirectory()

The TETemplatedDirectory destructor is the class destructor.

void setId(te_oid id)

The setId method sets the templated directory's unique ID.

Parameters

ParameterDescription
idSet templated directory ID.

te_oid getId() const

The getId method retrieves the templated directory's unique ID.

Returns: Get templated directory ID.

void setHostId(te_oid id)

The setHostId method sets the templated directory's host ID.

Parameters

ParameterDescription
idSet templated directory's host ID.

te_oid getHostId() const

The getHostId method retrieves the templated directory's unique ID.

Returns: Get templated directory ID.

void setPath(const _TESTD string &path)

The setPath method sets the templated directory path.

Parameters

ParameterDescription
pathString of path.

const _TESTD string getPath() const

The getPath method retrieves the templated directory path.

Returns: String of path

void setAlias(const _TESTD string &alias)

The setAlias method sets the templated directory path's alias.

Parameters

ParameterDescription
aliasString of path's alias.

const _TESTD string getAlias() const

The getAlias method retrieves the templated directory path's alias.

Returns: String of path's alias

void setAclTemplateId(te_oid id)

The setAclTemplateId sets the ACL's unique Template ID.

Parameters

ParameterDescription
idSet ACL Template ID.

te_oid getAclTemplateId() const

The getAclTemplateId retrieves the ACL's unique Template ID.

Returns: Get ACL Template ID.

void setFlag(uint32_t flag)

The setFlag method sets flag.

Parameters

ParameterDescription
flagFlag to be set.

Remark: See TEMPLATED_DIRECTORY_FLAG.

uint32_t getFlag() const

The getFlag method retrieves the flag.

Remark: See TEMPLATED_DIRECTORY_FLAG.

Returns: Returns flag.

TEObject * clone() const

The clone method clones a TETemplatedDirectory object.

Returns: Cloned TETemplatedDirectory object.