com.crystaldecisions.sdk.plugin.desktop.common
Interface IScopeBatchScope

public interface IScopeBatchScope

This interface provides detailed information about a scope within a scope batch.

Method Summary

IScopeProfileValues	getDocumentProfileValues() Returns a collection of profile values.
IScopeProfileValues	getDocumentProfileValues(int documentID) Returns a read-only collection of profile values for the specified document.
IDynamicRecipientInfos	getDynamicRecipientInfos() Returns a read-only collection of dynamic recipient information.
IDynamicRecipientProfileValuesSet	getDynamicRecipientProfileValuesSet() Returns a read-only collection of dynamic recipients profile values.
IScopePrincipals	getPrincipals() Returns the principals included in this scope.
boolean	isGenerateArtifacts() Returns whether this scope needs to generate artifacts.
void	setGenerateArtifacts(boolean value) Sets whether this scope needs to generate artifacts.

Method Detail

getPrincipals

IScopePrincipals getPrincipals()

Returns the principals included in this scope.

Returns:

An IScopePrincipals collection containing the principals for this scope.

getDocumentProfileValues

IScopeProfileValues getDocumentProfileValues(int documentID)

Returns a read-only collection of profile values for the specified document.

Returns:

An IScopeProfileValues collection containing the profile values.

getDocumentProfileValues

IScopeProfileValues getDocumentProfileValues()

Returns a collection of profile values.

Note: This is used for copying profile values to document processing info.

Returns:

A collection of profile values.

getDynamicRecipientInfos

IDynamicRecipientInfos getDynamicRecipientInfos()

Returns a read-only collection of dynamic recipient information.

Returns:

A read-only collection of dynamic recipient information.

getDynamicRecipientProfileValuesSet

IDynamicRecipientProfileValuesSet getDynamicRecipientProfileValuesSet()

Returns a read-only collection of dynamic recipients profile values.

Returns:

A IDynamicRecipientProfileValuesSet collection containing dynamic recipients profile values.

isGenerateArtifacts

boolean isGenerateArtifacts()

Returns whether this scope needs to generate artifacts.

Returns:

true if the scope needs to generate artifacts, false otherwise.

setGenerateArtifacts

void setGenerateArtifacts(boolean value)
                          throws SDKException

Sets whether this scope needs to generate artifacts.

Parameters:

value - true if the scope needs to generate artifacts, false otherwise.

Throws:

SDKException