jpa.p1.pub
Class PubDataset

java.lang.Object
  |
  +--jpa.p1.pub.PubDataset

public class PubDataset

extends java.lang.Object

This class represents a single PlatformOne dataset. It is implemented by the JPA PlatformOne Publishing package, and is accessed via an invocation of the getDataset method in the Publisher class.

Method Summary

void	cancel(PubDatasetEvent event) This method cancels a watch on the dataset.
boolean	canPublishPages() This method checks to see if this dataset will accept publication of pages; page publishing is not supported in this release of the JPA PlatformOne Publishing package.
boolean	canPublishRecords() This method checks to see if this dataset will accept publication of records.
PubRecord	createRecord(java.lang.String name) This method creates a new, empty record object.
void	deleteRecord(PubRecord record) This method deletes a record object.
java.lang.String	getName() This method returns the dataset name.
int	getNumSchema() This method returns the number of available schemata.
PubSchema	getSchema(int schema) This method returns a reference to an individual schema.
void	watch(PubDatasetEvent event) This method watches the dataset to see when it is ready to receive published data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getName

public java.lang.String getName()

This method returns the dataset name.

watch

public void watch(PubDatasetEvent event)

This method watches the dataset to see when it is ready to receive published data. The single argument is a reference to an object in the application that implements the PubDatasetEvent interface. This is used to receive notifications that the dataset is ready or otherwise.

cancel

public void cancel(PubDatasetEvent event)

This method cancels a watch on the dataset.

createRecord

public PubRecord createRecord(java.lang.String name)

This method creates a new, empty record object. It is not yet opened for publication on the target host.

deleteRecord

public void deleteRecord(PubRecord record)

This method deletes a record object. It is not automatically closed on the target host.

canPublishRecords

public boolean canPublishRecords()

This method checks to see if this dataset will accept publication of records.

canPublishPages

public boolean canPublishPages()

This method checks to see if this dataset will accept publication of pages; page publishing is not supported in this release of the JPA PlatformOne Publishing package.

getNumSchema

public int getNumSchema()

This method returns the number of available schemata.

getSchema

public PubSchema getSchema(int schema)

This method returns a reference to an individual schema.