CTDocProtect (docx4j-openxml-objects 8.3.1 API)

java.lang.Object
- org.docx4j.wml.CTDocProtect

All Implemented Interfaces:: Child

public class CTDocProtect
extends Object
implements Child

Java class for CT_DocProtect complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="CT_DocProtect">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attGroup ref="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}AG_Password"/>
       <attribute name="edit" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_DocProtect" />
       <attribute name="formatting" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="enforcement" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`algIdExt`
`protected String`	`algIdExtSource`
`protected STAlgClass`	`cryptAlgorithmClass`
`protected BigInteger`	`cryptAlgorithmSid`
`protected STAlgType`	`cryptAlgorithmType`
`protected String`	`cryptProvider`
`protected STCryptProv`	`cryptProviderType`
`protected String`	`cryptProviderTypeExt`
`protected String`	`cryptProviderTypeExtSource`
`protected BigInteger`	`cryptSpinCount`
`protected STDocProtect`	`edit`
`protected Boolean`	`enforcement`
`protected Boolean`	`formatting`
`protected byte[]`	`hash`
`protected byte[]`	`salt`

Constructor Summary

Constructors
Constructor and Description

CTDocProtect()

Constructors
Constructor and Description
`CTDocProtect()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(Unmarshaller unmarshaller, Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`String`	`getAlgIdExt()` Gets the value of the algIdExt property.
`String`	`getAlgIdExtSource()` Gets the value of the algIdExtSource property.
`STAlgClass`	`getCryptAlgorithmClass()` Gets the value of the cryptAlgorithmClass property.
`BigInteger`	`getCryptAlgorithmSid()` Gets the value of the cryptAlgorithmSid property.
`STAlgType`	`getCryptAlgorithmType()` Gets the value of the cryptAlgorithmType property.
`String`	`getCryptProvider()` Gets the value of the cryptProvider property.
`STCryptProv`	`getCryptProviderType()` Gets the value of the cryptProviderType property.
`String`	`getCryptProviderTypeExt()` Gets the value of the cryptProviderTypeExt property.
`String`	`getCryptProviderTypeExtSource()` Gets the value of the cryptProviderTypeExtSource property.
`BigInteger`	`getCryptSpinCount()` Gets the value of the cryptSpinCount property.
`STDocProtect`	`getEdit()` Gets the value of the edit property.
`byte[]`	`getHash()` Gets the value of the hash property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`byte[]`	`getSalt()` Gets the value of the salt property.
`boolean`	`isEnforcement()` Gets the value of the enforcement property.
`boolean`	`isFormatting()` Gets the value of the formatting property.
`void`	`setAlgIdExt(String value)` Sets the value of the algIdExt property.
`void`	`setAlgIdExtSource(String value)` Sets the value of the algIdExtSource property.
`void`	`setCryptAlgorithmClass(STAlgClass value)` Sets the value of the cryptAlgorithmClass property.
`void`	`setCryptAlgorithmSid(BigInteger value)` Sets the value of the cryptAlgorithmSid property.
`void`	`setCryptAlgorithmType(STAlgType value)` Sets the value of the cryptAlgorithmType property.
`void`	`setCryptProvider(String value)` Sets the value of the cryptProvider property.
`void`	`setCryptProviderType(STCryptProv value)` Sets the value of the cryptProviderType property.
`void`	`setCryptProviderTypeExt(String value)` Sets the value of the cryptProviderTypeExt property.
`void`	`setCryptProviderTypeExtSource(String value)` Sets the value of the cryptProviderTypeExtSource property.
`void`	`setCryptSpinCount(BigInteger value)` Sets the value of the cryptSpinCount property.
`void`	`setEdit(STDocProtect value)` Sets the value of the edit property.
`void`	`setEnforcement(Boolean value)` Sets the value of the enforcement property.
`void`	`setFormatting(Boolean value)` Sets the value of the formatting property.
`void`	`setHash(byte[] value)` Sets the value of the hash property.
`void`	`setParent(Object parent)`
`void`	`setSalt(byte[] value)` Sets the value of the salt property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - edit
```
protected STDocProtect edit
```
  - formatting
```
protected Boolean formatting
```
  - enforcement
```
protected Boolean enforcement
```
  - cryptProviderType
```
protected STCryptProv cryptProviderType
```
  - cryptAlgorithmClass
```
protected STAlgClass cryptAlgorithmClass
```
  - cryptAlgorithmType
```
protected STAlgType cryptAlgorithmType
```
  - cryptAlgorithmSid
```
protected BigInteger cryptAlgorithmSid
```
  - cryptSpinCount
```
protected BigInteger cryptSpinCount
```
  - cryptProvider
```
protected String cryptProvider
```
  - algIdExt
```
protected String algIdExt
```
  - algIdExtSource
```
protected String algIdExtSource
```
  - cryptProviderTypeExt
```
protected String cryptProviderTypeExt
```
  - cryptProviderTypeExtSource
```
protected String cryptProviderTypeExtSource
```
  - hash
```
protected byte[] hash
```
  - salt
```
protected byte[] salt
```
- Constructor Detail
  - CTDocProtect
```
public CTDocProtect()
```
- Method Detail
  - getEdit
```
public STDocProtect getEdit()
```
    Gets the value of the edit property.
    
    Returns:
    
    possible object is STDocProtect
  - setEdit
```
public void setEdit(STDocProtect value)
```
    Sets the value of the edit property.
    
    Parameters:
    
    value - allowed object is STDocProtect
  - isFormatting
```
public boolean isFormatting()
```
    Gets the value of the formatting property.
    
    Returns:
    
    possible object is Boolean
  - setFormatting
```
public void setFormatting(Boolean value)
```
    Sets the value of the formatting property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isEnforcement
```
public boolean isEnforcement()
```
    Gets the value of the enforcement property.
    
    Returns:
    
    possible object is Boolean
  - setEnforcement
```
public void setEnforcement(Boolean value)
```
    Sets the value of the enforcement property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getCryptProviderType
```
public STCryptProv getCryptProviderType()
```
    Gets the value of the cryptProviderType property.
    
    Returns:
    
    possible object is STCryptProv
  - setCryptProviderType
```
public void setCryptProviderType(STCryptProv value)
```
    Sets the value of the cryptProviderType property.
    
    Parameters:
    
    value - allowed object is STCryptProv
  - getCryptAlgorithmClass
```
public STAlgClass getCryptAlgorithmClass()
```
    Gets the value of the cryptAlgorithmClass property.
    
    Returns:
    
    possible object is STAlgClass
  - setCryptAlgorithmClass
```
public void setCryptAlgorithmClass(STAlgClass value)
```
    Sets the value of the cryptAlgorithmClass property.
    
    Parameters:
    
    value - allowed object is STAlgClass
  - getCryptAlgorithmType
```
public STAlgType getCryptAlgorithmType()
```
    Gets the value of the cryptAlgorithmType property.
    
    Returns:
    
    possible object is STAlgType
  - setCryptAlgorithmType
```
public void setCryptAlgorithmType(STAlgType value)
```
    Sets the value of the cryptAlgorithmType property.
    
    Parameters:
    
    value - allowed object is STAlgType
  - getCryptAlgorithmSid
```
public BigInteger getCryptAlgorithmSid()
```
    Gets the value of the cryptAlgorithmSid property.
    
    Returns:
    
    possible object is BigInteger
  - setCryptAlgorithmSid
```
public void setCryptAlgorithmSid(BigInteger value)
```
    Sets the value of the cryptAlgorithmSid property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getCryptSpinCount
```
public BigInteger getCryptSpinCount()
```
    Gets the value of the cryptSpinCount property.
    
    Returns:
    
    possible object is BigInteger
  - setCryptSpinCount
```
public void setCryptSpinCount(BigInteger value)
```
    Sets the value of the cryptSpinCount property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getCryptProvider
```
public String getCryptProvider()
```
    Gets the value of the cryptProvider property.
    
    Returns:
    
    possible object is String
  - setCryptProvider
```
public void setCryptProvider(String value)
```
    Sets the value of the cryptProvider property.
    
    Parameters:
    
    value - allowed object is String
  - getAlgIdExt
```
public String getAlgIdExt()
```
    Gets the value of the algIdExt property.
    
    Returns:
    
    possible object is String
  - setAlgIdExt
```
public void setAlgIdExt(String value)
```
    Sets the value of the algIdExt property.
    
    Parameters:
    
    value - allowed object is String
  - getAlgIdExtSource
```
public String getAlgIdExtSource()
```
    Gets the value of the algIdExtSource property.
    
    Returns:
    
    possible object is String
  - setAlgIdExtSource
```
public void setAlgIdExtSource(String value)
```
    Sets the value of the algIdExtSource property.
    
    Parameters:
    
    value - allowed object is String
  - getCryptProviderTypeExt
```
public String getCryptProviderTypeExt()
```
    Gets the value of the cryptProviderTypeExt property.
    
    Returns:
    
    possible object is String
  - setCryptProviderTypeExt
```
public void setCryptProviderTypeExt(String value)
```
    Sets the value of the cryptProviderTypeExt property.
    
    Parameters:
    
    value - allowed object is String
  - getCryptProviderTypeExtSource
```
public String getCryptProviderTypeExtSource()
```
    Gets the value of the cryptProviderTypeExtSource property.
    
    Returns:
    
    possible object is String
  - setCryptProviderTypeExtSource
```
public void setCryptProviderTypeExtSource(String value)
```
    Sets the value of the cryptProviderTypeExtSource property.
    
    Parameters:
    
    value - allowed object is String
  - getHash
```
public byte[] getHash()
```
    Gets the value of the hash property.
    
    Returns:
    
    possible object is byte[]
  - setHash
```
public void setHash(byte[] value)
```
    Sets the value of the hash property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getSalt
```
public byte[] getSalt()
```
    Gets the value of the salt property.
    
    Returns:
    
    possible object is byte[]
  - setSalt
```
public void setSalt(byte[] value)
```
    Sets the value of the salt property.
    
    Parameters:
    
    value - allowed object is byte[]
  - getParent
```
public Object getParent()
```
    Gets the parent object in the object tree representing the unmarshalled xml document.
    
    Specified by:
    
    getParent in interface Child
    
    Returns:
    
    The parent object.
  - setParent
```
public void setParent(Object parent)
```
    Specified by:
    
    setParent in interface Child
  - afterUnmarshal
```
public void afterUnmarshal(Unmarshaller unmarshaller,
                           Object parent)
```
    This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
    
    Parameters:
    
    parent - The parent object in the object tree.
    
    unmarshaller - The unmarshaller that generated the instance.

Class CTDocProtect

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

edit

formatting

enforcement

cryptProviderType

cryptAlgorithmClass

cryptAlgorithmType

cryptAlgorithmSid

cryptSpinCount

cryptProvider

algIdExt

algIdExtSource

cryptProviderTypeExt

cryptProviderTypeExtSource

hash

salt

Constructor Detail

CTDocProtect

Method Detail

getEdit

setEdit

isFormatting

setFormatting

isEnforcement

setEnforcement

getCryptProviderType

setCryptProviderType

getCryptAlgorithmClass

setCryptAlgorithmClass

getCryptAlgorithmType

setCryptAlgorithmType

getCryptAlgorithmSid

setCryptAlgorithmSid

getCryptSpinCount

setCryptSpinCount

getCryptProvider

setCryptProvider

getAlgIdExt

setAlgIdExt

getAlgIdExtSource

setAlgIdExtSource

getCryptProviderTypeExt

setCryptProviderTypeExt

getCryptProviderTypeExtSource

setCryptProviderTypeExtSource

getHash

setHash

getSalt

setSalt

getParent

setParent

afterUnmarshal