epc::CoreProperty Class Reference

#include <CoreProperty.h>

Public Types
enum	TypeProperty {   category = 0 , contentStatus = 1 , created = 2 , creator = 3 ,   description = 4 , identifier = 5 , keywords = 6 , language = 7 ,   lastModifiedBy = 8 , lastPrinted = 9 , modified = 10 , revision = 11 ,   subject = 12 , title = 13 , version = 14 , undefinedCoreProperty = 15 }

Public Member Functions
	CoreProperty ()
	CoreProperty (TypeProperty pType)
	CoreProperty (TypeProperty pType, const std::string &pValue)
	CoreProperty (TypeProperty pType, const std::vector< std::string > &pValue)
	~CoreProperty ()=default
bool	isEmpty () const
TypeProperty	getTypeProperty () const
void	setTypeProperty (TypeProperty corePropertyType)
const std::vector< std::string > &	getAllValue () const
std::string	getValue (size_t index=0) const
std::string	toString () const
void	setCategory (std::string pValue)
void	setContentStatus (std::string pValue)
void	setCreated (std::string pValue)
void	setCreator (std::string pValue)
void	setDescription (std::string pValue)
void	setIdentifier (std::string pValue)
void	setKeywords (std::string pValue)
void	addKeywords (std::string pValue)
void	setLanguage (std::string pValue)
void	setLastModifiedBy (std::string pValue)
void	setLastPrinted (std::string pValue)
void	setModified (std::string pValue)
void	setRevision (std::string pValue)
void	setSubject (std::string pValue)
void	setTitle (std::string pValue)
void	setVersion (std::string pValue)

Detailed Description

A core property.

Member Enumeration Documentation

TypeProperty

enum epc::CoreProperty::TypeProperty

Enumeration of the various types of the core properties.

Constructor & Destructor Documentation

CoreProperty() [1/4]

epc::CoreProperty::CoreProperty

(

)

Default constructor

CoreProperty() [2/4]

epc::CoreProperty::CoreProperty ( TypeProperty pType )

explicit

Constructor

Parameters

pType

The type.

CoreProperty() [3/4]

epc::CoreProperty::CoreProperty	(	TypeProperty	pType,
		const std::string &	pValue )

Constructor

Parameters

pType	The type.
pValue	The value.

CoreProperty() [4/4]

epc::CoreProperty::CoreProperty	(	TypeProperty	pType,
		const std::vector< std::string > &	pValue )

Constructor

Parameters

pType	The type.
pValue	The value.

~CoreProperty()

epc::CoreProperty::~CoreProperty ( )

default

Destructor

Member Function Documentation

addKeywords()

void epc::CoreProperty::addKeywords

(

std::string

pValue

)

Adds the keywords

Parameters

pValue

The value.

getAllValue()

const std::vector< std::string > & epc::CoreProperty::getAllValue

(

)

const

Get all the string values. Relevant only for some core properties which can have several string values (such as keywords)

Returns

all value.

getTypeProperty()

TypeProperty epc::CoreProperty::getTypeProperty

(

)

const

Get the type of the core property.

Returns

The type property.

getValue()

std::string epc::CoreProperty::getValue

(

size_t

index = 0

)

const

Get the first string value of the core property. Usually this method is the common one for retrieving string value of a core property since most of timeonly one string value is necessary for one core property.

Parameters

index

(Optional) Zero-based index of the.

Returns

The value.

isEmpty()

bool epc::CoreProperty::isEmpty

(

)

const

Indicate wether a property has got a string value or not

Returns

True if empty, false if not.

setCategory()

void epc::CoreProperty::setCategory

(

std::string

pValue

)

Sets a category

Parameters

pValue

The value.

setContentStatus()

void epc::CoreProperty::setContentStatus

(

std::string

pValue

)

Sets content status

Parameters

pValue

The value.

setCreated()

void epc::CoreProperty::setCreated

(

std::string

pValue

)

Sets a created

Parameters

pValue

The value.

setCreator()

void epc::CoreProperty::setCreator

(

std::string

pValue

)

Sets a creator

Parameters

pValue

The value.

setDescription()

void epc::CoreProperty::setDescription

(

std::string

pValue

)

Sets a description

Parameters

pValue

The value.

setIdentifier()

void epc::CoreProperty::setIdentifier

(

std::string

pValue

)

Sets an identifier

Parameters

pValue

The value.

setKeywords()

void epc::CoreProperty::setKeywords

(

std::string

pValue

)

Sets the keywords

Parameters

pValue

The value.

setLanguage()

void epc::CoreProperty::setLanguage

(

std::string

pValue

)

Sets a language

Parameters

pValue

The value.

setLastModifiedBy()

void epc::CoreProperty::setLastModifiedBy

(

std::string

pValue

)

Sets last modified by

Parameters

pValue

The value.

setLastPrinted()

void epc::CoreProperty::setLastPrinted

(

std::string

pValue

)

Sets last printed

Parameters

pValue

The value.

setModified()

void epc::CoreProperty::setModified

(

std::string

pValue

)

Sets a modified

Parameters

pValue

The value.

setRevision()

void epc::CoreProperty::setRevision

(

std::string

pValue

)

Sets a revision

Parameters

pValue

The value.

setSubject()

void epc::CoreProperty::setSubject

(

std::string

pValue

)

Sets a subject

Parameters

pValue

The value.

setTitle()

void epc::CoreProperty::setTitle

(

std::string

pValue

)

Sets a title

Parameters

pValue

The value.

setTypeProperty()

void epc::CoreProperty::setTypeProperty

(

TypeProperty

corePropertyType

)

Set the type of the core property

Parameters

corePropertyType

Type of the core property.

setVersion()

void epc::CoreProperty::setVersion

(

std::string

pValue

)

Sets a version

Parameters

pValue

The value.

toString()

std::string epc::CoreProperty::toString

(

)

const

Serialize the core property into an XML element embeded into a string.

Returns

A std::string that represents this object.

---

The documentation for this class was generated from the following file:

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/epc/CoreProperty.h