Package com.redwood.scheduler.api.r2w.publish

Interface R2WMetaData

public interface R2WMetaData

The R2D XML wrapper API

Method Summary

Modifier and Type	Method	Description
void	addKeyword(String name, String value)	Add a keyword to the meta data
void	addKeyword(String name, String value, String page)	Add a keyword to the meta data with the page
Long	getJobId()	Get the JobId
void	setAuthor(String author)	Set the author of the document
void	setDefaultFormat(String extension)	The default format to apply to the publication
void	setDescription(String desc)	The description of the file
void	setExpiration(DateTimeZone expirationDate)	The expiration date to expire the document on
void	setFileName(String fileName)	The filename of the publication
void	setJobId(Long jobId)	Set the JobId in the meta data
void	setPublicationProfile(String profileName)	Set the publication profile name
void	setSubject(String subject)	Set the subject of the document (this will default to description if not set)
void	setTitle(String title)	Set the title of the document
void	writeXML(OutputStream os)	Write the R2D XML to the output stream.

Method Detail

setJobId

void setJobId(Long jobId)

Set the JobId in the meta data

Parameters:

jobId - the JobId

getJobId

Long getJobId()

Get the JobId

Returns:

the Job Id

setDescription

void setDescription(String desc)

The description of the file

Parameters:

desc - the description

addKeyword

void addKeyword(String name,
                String value)

Add a keyword to the meta data

Parameters:

name - the keyword name

value - the keyword value

addKeyword

void addKeyword(String name,
                String value,
                String page)

Add a keyword to the meta data with the page

Parameters:

name - the keyword name

value - the keyword value

page - the page of the keyword

setTitle

void setTitle(String title)

Set the title of the document

Parameters:

title - the title

setSubject

void setSubject(String subject)

Set the subject of the document (this will default to description if not set)

Parameters:

subject - the subject

setAuthor

void setAuthor(String author)

Set the author of the document

Parameters:

author - the author

setDefaultFormat

void setDefaultFormat(String extension)

The default format to apply to the publication

Parameters:

extension - the extension of the default format

setExpiration

void setExpiration(DateTimeZone expirationDate)

The expiration date to expire the document on

Parameters:

expirationDate - the date

setFileName

void setFileName(String fileName)

The filename of the publication

Parameters:

fileName - the filename

setPublicationProfile

void setPublicationProfile(String profileName)

Set the publication profile name

Parameters:

profileName - the name of the publication profile

writeXML

void writeXML(OutputStream os)
       throws IOException

Write the R2D XML to the output stream. Note the OutputStream is not closed by this method.

Parameters:

os - the stream to write to

Throws:

IOException - if the write fails