# RHNodeVersion

Inherits from: RHObject :: RHWrapper :: RHPrimaryKey

# Class Methods

# Inherited methods

Destructor ErrorAssoc OKAssoc

# GetVersionID

function Integer GetVersionID(Object prgCtx, Dynamic item)

# New

function Dynamic New(Object prgCtx, Dynamic item=Undefined)

# Overrides:

New in class RHObject

# Instance Methods

# Property Methods

Property methods can be accessed with the valueForKey method.

attrdata base64 cachekey categories categoryvalues categoryvaluesidentifier checksum classidentifier classname clone comment content createdate dapinode dapiversion dataid downloadurl dpsdocumentproperties errorassoc fileextension filename filesize filetype gif gif32 guid hash identityhashcode img img145 img32 isadvancedversioning islocked ismajorversion isminorversion ispdf isrendition isreserved istextmimetype isvalid isversioned iterator lock metadata metadatatype methods mimetype modifydate name node noderec nodeversion okassoc owner ownerid pk propertymethods providerid providerinfo providername providernamelong renditions renditiontypes reset serialize size storagepath string subtype thumbnailurl tobase64 tohtml totext type unlock url user userid version versionmajor versionminor versionnum versiontype vertype webnode

# Inherited methods

assert cacheKey cacheKeyTouch cacheMethod cacheValueForKey callSuper checkError class classIdentifier className clone deserialize dict endTrans identityHashCode isAccessorMethod isCached isEqual isInstanceOf isProperty isPropertyMethod isPropertyRelated iterator lrucacheGet lrucacheSet memcachedDelete memcachedGet memcachedGetValue memcachedSet metadata metadataDelete metadataGet metadataSet methods model_get model_set pluck prepareForReuse propertyMethods removeFromCache reset resetCache resolveRelatedProperty respondsTo setCacheValueForKey setValueForKey setValueForKeyPath startTrans super touch valueForKey valueForKeyPath

# attrdata

function Frame attrdata()

Returns an RHAttrData.

# base64

function String toBase64()

# categories

function Frame categories()

# categoryValues

function Assoc categoryValues()

# categoryValuesIdentifier

function Assoc categoryValuesIdentifier()

# checksum

function String checksum(String algorithm = 'sha1')

# comment

function String comment()

# content

function Dynamic content(Boolean noAudit=false)

# convertToHTML

function Assoc ConvertToHTML(Record request)

# createDate

function Date createDate()

# dapinode

function DAPINODE dapinode()

# dapiversion

function DAPIVERSION dapiversion()

# dataid

function Integer dataid()

# delete

function Assoc delete()

# downloadUrl

function String downloadUrl()

# dpsBindings

function Assoc dpsBindings(Integer event)

# dpsDocumentProperties

function Assoc dpsDocumentProperties()

# fileextension

function String fileextension()

# filename

function String filename()

# filesize

function String filesize()

# filetype

function String filetype()

# gif

function String gif()

Returns the 16x16 icon URL for this version.

# gif32

function String gif32()

Returns the 32x32 icon URL for this version.

# guid

function String guid()

# hash

function String hash()

# Overrides:

hash in class RHObject

# img

function String img()

# img145

function String img()

# img32

function String img32()

# isAdvancedVersioning

function Boolean isAdvancedVersioning()

# isInCollection

function Assoc isInCollection(Dynamic collectionRef)

# isLocked

function Boolean isLocked()

# isMajorVersion

function Boolean isMajorVersion()

# isMinorVersion

function Boolean isMinorVersion()

# isPDF

function Boolean isPDF()

# isRendition

function Boolean isRendition()

# isReserved

function Boolean isReserved()

# isTextMimetype

function Boolean isTextMimetype()

# isValid

function Boolean isValid()

# Overrides:

isValid in class RHPrimaryKey

# isVersioned

function Boolean isVersioned()

# Returns

Returns true if this node versioned.

# link

function String link(Record request=$RHCore.Utils.FakeRequest(.fPrgCtx), String cmdName="open", String anchor=Undefined, String nextURL=Undefined, Boolean disabledlink=false)

# llnode

function Object llnode(Integer subType=Undefined)

# lock

function Assoc lock()

# metadataType

function Integer metadataType()

# Overrides:

metadataType in class RHPrimaryKey

# mimetype

function String mimetype()

# modifyDate

function Date modifydate()

# name

function String name()

# node

function Frame node()

# nodeRec

function Record nodeRec()

# nodeVersion

function Frame nodeVersion()

# owner

function Frame ownwer()

# ownerid

function Integer ownerid()

# pk

function Integer pk()

# Overrides:

pk in class RHPrimaryKey

# primitiveValueForKey

function Dynamic primitiveValueForKey(String key, Dynamic defaultValue=Undefined)

This method returns the raw value (i.e., a value from the Record for this node type). It's called by valueForKey() if an accessor method or non script feature is found on the object with the given key.

# Overrides:

primitiveValueForKey in class RHWrapper

# promote

function Assoc promote()

TODO: Should we assert the current version isn't a rendition? Apparently this doesn't work with renditions. Or is the error already handled?

# providerChange

function Assoc providerChange(String provider)

# providerID

function Integer providerID()

# providerInfo

function Assoc providerInfo()

# providerName

function String providerName()

# providerNameLong

function String providerNameLong()

# putInCollection

function Assoc putInCollection(Dynamic collectionRef, Boolean updateSizeAndDate = true)

# removeFromCollection

function Assoc removeFromCollection(Dynamic collectionRef, Boolean updateSizeAndDate = true)

# rename

function Assoc rename(String newName)

# rendition

function Frame rendition(String verType)

# renditionAdd

function Assoc renditionAdd(String filePath, String verType, String mimetype=$RHCore.FileUtils.GetMimeType(filePath), String fileName=File.GetName(filePath))

Add a rendition to this version.

# Parameters

filePath - The file system path.
verType - The rendition type.
mimetype - (Optional) The rendition mimetype.
fileName - (Optional) The rendition filename

# Returns

An assoc with the status of the rendition creation. The node is that of the original version and nodeVersion is the newly added rendition.

# renditionAddFromVersion

function Assoc renditionAddFromVersion(Frame sourceNodeVersion, String verType)

Content Server doesn't allow versions to be added as renditions of another version.

# renditionDeleteAll

function Assoc renditionDeleteAll()

# renditionHasType

function Boolean renditionHasType(String renditionType)

# renditions

function Frame renditions()

# renditionTypes

function List renditiontypes()

# resetSubclass

function Void resetSubclass()

# Overrides:

resetSubclass in class RHObject

# saveToFile

function Assoc saveToFile(String filePath, Assoc fetchInfo=Assoc.CreateAssoc())

This function also works with regular versions and renditions.

fetchInfo.NoAudit = true

# serialize

function Dynamic serialize()

# Overrides:

serialize in class RHObject

# setComment

function Assoc setComment(String comment)

# setFilename

function Assoc setFilename(String newName)

# setMimetype

function Assoc setMimetype(String mimeType)

# setValues

function Frame setValues(Dynamic value)

value can be the VersionID

# Overrides:

setValues in class RHObject

# size

function String size()

# storagepath

function String storagepath()

# storagepath2

function Assoc storagepath2()

# string

function String string()

This method returns a string representation of the object.

# Overrides:

string in class RHObject

# subtype

function Integer subtype()

Returns the subtype integer of this node.

# test

function Assoc test(Integer major, Integer minor)

# thumbnailUrl

function Assoc thumbnailUrl(Integer pageNumber=1)

# toBase64

function String toBase64()

# toHTML

function String toHTML()

# toText

function String toText(Boolean noAudit=false)

# type

function String type()

# unlock

function Assoc unlock()

# updateVersion

function Assoc updateVersion(Assoc updateInfo=Undefined)

# url

function String url(Record request=$RHCore.Utils.GetRequest(.fPrgCtx), String cmdName='versionProperties', String nextUrl=Undefined)

# user

function Frame user()

# userid

function Integer userid()

# version

function Integer version()

# versionMajor

function Integer versionMajor()

# versionMinor

function Integer versionMinor()

# versionNum

function String versionNum()

# versionType

function String versionType()

# verType

function String verType()

# webNode

function Object webNode(Integer subType=.subtype())

← RHNodeQuery RHObject →