com.hcl.domino.admin.replication

Interface ReplicaInfo

All Superinterfaces:

IAdaptable

public interface ReplicaInfo
extends IAdaptable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReplicaInfo.Priority

Method Summary

Modifier and Type	Method and Description
Optional<DominoDateTime>	getCutOff() Replication cutoff date
int	getCutOffInterval() Automatic Replication Cutoff Interval (Days)
Database	getParentDatabase() Returns the database this replica info belongs to
ReplicaInfo.Priority	getPriority() Reads the current replication priority
String	getReplicaID() Returns the replica ID as hex encoded string with 16 characters
DominoDateTime	getReplicaIDAsDate() Returns the replication ID which is same for all replica files
Set<ReplicationFlags>	getReplicationFlags()
boolean	isDesignHidden() Checks if the database design is hidden
boolean	isReplicationFlagSet(ReplicationFlags flag) Returns true if a replication flag is set
void	setCutOff(TemporalAccessor cutOff) Sets the new cutoff date
void	setCutOffInterval(int interval) Sets the Automatic Replication Cutoff Interval (Days)
String	setNewReplicaId() Computes a new replica id and calls setReplicaID(String)
void	setPriority(ReplicaInfo.Priority priority) Changes the replication priority
void	setReplicaID(String replicaId) Method to set the replica ID as hex encoded string with 16 characters
void	setReplicaIDAsDate(TemporalAccessor newID) Sets the replication ID which is same for all replica files
void	setReplicationFlag(ReplicationFlags flag, boolean on) Method to change a replication flag

Methods inherited from interface com.hcl.domino.data.IAdaptable

getAdapter

Method Detail

getParentDatabase

Database getParentDatabase()

Returns the database this replica info belongs to

Returns:

parent database

getReplicaIDAsDate

DominoDateTime getReplicaIDAsDate()

Returns the replication ID which is same for all replica files

Returns:

ID

setReplicaIDAsDate

void setReplicaIDAsDate(TemporalAccessor newID)

Sets the replication ID which is same for all replica files

Parameters:

newID - new ID

isDesignHidden

boolean isDesignHidden()

Checks if the database design is hidden

Returns:

true if hidden

getCutOffInterval

int getCutOffInterval()

Automatic Replication Cutoff Interval (Days)

Returns:

interval

setCutOffInterval

void setCutOffInterval(int interval)

Sets the Automatic Replication Cutoff Interval (Days)

Parameters:

interval - (WORD)

getCutOff

Optional<DominoDateTime> getCutOff()

Replication cutoff date

Returns:

an Optional describing the cutoff date if set, or an empty one otherwise

setCutOff

void setCutOff(TemporalAccessor cutOff)

Sets the new cutoff date

Parameters:

cutOff - date

getReplicaID

String getReplicaID()

Returns the replica ID as hex encoded string with 16 characters

Returns:

replica id

setReplicaID

void setReplicaID(String replicaId)

Method to set the replica ID as hex encoded string with 16 characters

Parameters:

replicaId - new replica id, either 16 characters of 8:8 format

setNewReplicaId

String setNewReplicaId()

Computes a new replica id and calls setReplicaID(String)

Returns:

the new replica id

getReplicationFlags

Set<ReplicationFlags> getReplicationFlags()

isReplicationFlagSet

boolean isReplicationFlagSet(ReplicationFlags flag)

Returns true if a replication flag is set

Parameters:

flag - flag

Returns:

true if set

setReplicationFlag

void setReplicationFlag(ReplicationFlags flag,
                        boolean on)

Method to change a replication flag

Parameters:

flag - flag to change

on - new flag value (on or off)

getPriority

ReplicaInfo.Priority getPriority()

Reads the current replication priority

Returns:

priority

setPriority

void setPriority(ReplicaInfo.Priority priority)

Changes the replication priority

Parameters:

priority - new priority