com.edustructures.sifworks
Class PublishingOptions

java.lang.Object
  com.edustructures.sifworks.ProvisioningOptions
      com.edustructures.sifworks.PublishingOptions

Direct Known Subclasses:

ReportPublishingOptions

public class PublishingOptions
extends ProvisioningOptions

Encapsulates all of the optional behavior that a publisher is able to support. Flags in this class are used to control behavior of the agent during provisioning

Constructor Summary

PublishingOptions()
Creates an instance of PublishingOptions that supports the default SIF Context.

PublishingOptions(boolean sendSIFProvide)
Creates an instance of PublishingOptions that supports the default SIF Context.

PublishingOptions(boolean sendSIFProvide, SIFContext... contexts)
Creates an instance of PublishingOptions that only supports the given set of SIFContext.

PublishingOptions(SIFContext... contexts)
Creates an instance of PublishingOptions that only supports the given set of SIFContexts.

Method Summary

boolean	getSendSIFProvide() Gets the flag that indicates whether or not the ADK should provision this agent as the default provider in the zone for the object.
boolean	getSupportsExtendedQuery() Sets a flag the indicates whether or not this publisher supports SIF_ExtendedQueries
void	setSendSIFProvide(boolean fSendSIFProvide) Sets a flag that indicates whether or not the ADK should provision this agent as the default provider in the zone for the object.
void	setSupportsExtendedQuery(boolean fSupportsExtendedQuery) Sets a flag the indicates whether or not this publisher supports SIF_ExtendedQueries

Methods inherited from class com.edustructures.sifworks.ProvisioningOptions

addSupportedContext, getSupportedContexts, supportsContext

Methods inherited from class java.lang.Object

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

Constructor Detail

PublishingOptions

public PublishingOptions()

Creates an instance of PublishingOptions that supports the default SIF Context.

Parameters:

sendSIFProvide - True if the ADK should provision this agent as the default provider in the zone for the object.

PublishingOptions

public PublishingOptions(boolean sendSIFProvide)

Creates an instance of PublishingOptions that supports the default SIF Context.

Parameters:

sendSIFProvide - True if the ADK should provision this agent as the default provider in the zone for the object.

PublishingOptions

public PublishingOptions(SIFContext... contexts)

Creates an instance of PublishingOptions that only supports the given set of SIFContexts.

Parameters:

contexts -

PublishingOptions

public PublishingOptions(boolean sendSIFProvide,
                         SIFContext... contexts)

Creates an instance of PublishingOptions that only supports the given set of SIFContext. If the set of contexts given does not include the default SIF context, the default context will not be supported by this ReportPublisher

Parameters:

sendSIFProvide - True if the ADK should provision this agent as the default provider in the zone for the object.

contexts - the explicit list of contexts to support

Method Detail

setSendSIFProvide

public void setSendSIFProvide(boolean fSendSIFProvide)

Sets a flag that indicates whether or not the ADK should provision this agent as the default provider in the zone for the object.

Parameters:

fSendSIFProvide -

getSendSIFProvide

public boolean getSendSIFProvide()

Gets the flag that indicates whether or not the ADK should provision this agent as the default provider in the zone for the object.

Returns:

setSupportsExtendedQuery

public void setSupportsExtendedQuery(boolean fSupportsExtendedQuery)

Sets a flag the indicates whether or not this publisher supports SIF_ExtendedQueries

Parameters:

fSupportsExtendedQuery - If false, the ADK will automatically send an error packet response back for any SIF_ExtendedQueries received.If true, the ADK will notify the zone of SIF_ExtendedQuery support during agent provisioning.

getSupportsExtendedQuery

public boolean getSupportsExtendedQuery()

Sets a flag the indicates whether or not this publisher supports SIF_ExtendedQueries

Returns:

If false, the ADK will automatically send an error packet response back for any SIF_ExtendedQueries received.If true, the ADK will notify the zone of SIF_ExtendedQuery support during agent provisioning.