com.tsgrp.opencontent.universal.redaction

Interface IRedaction

All Known Implementing Classes:

RedactionImpl

public interface IRedaction

Method Summary

Modifier and Type	Method and Description
java.util.List<RedactionSuggestion>	getRedactionSuggestions(java.lang.String ticket, java.lang.String objectId, long lastModified, int numPages) Returns a list of suggested redactions and their locations which have been detected in the document.
com.aspose.pdf.Document	redactTermsFromDocument(java.lang.String ticket, java.lang.String objectId, java.util.List<java.lang.String> stringToRedact) Helper that finds a string of text in a PDF and redacts instances of that text
java.util.List<java.lang.String>	redactTermsFromFolder(java.lang.String ticket, java.lang.String containerId, java.util.List<java.lang.String> stringsToRedact, java.lang.String redactionMode, java.lang.Boolean newVersion, java.lang.Boolean majorVersion) A method which will redact a list of terms from every document in a given folder.
java.util.List<java.lang.String>	redactTermsFromListOfIds(java.lang.String ticket, java.util.List<java.lang.String> objectIds, java.util.List<java.lang.String> stringsToRedact, java.lang.String redactionMode, java.lang.Boolean newVersion, java.lang.Boolean majorVersion) A method which will redact a list of terms from every objectID passed in
RedactionInfo	saveRedactions(java.lang.String ticket, java.lang.String objectId, java.lang.String parentId, java.lang.String redactionMode, Redaction[] redactions, java.lang.Boolean newVersion, java.lang.Boolean majorVersion) Saves the provided redactions, permanently modifying the provided document.

Method Detail

saveRedactions

RedactionInfo saveRedactions(java.lang.String ticket,
                             java.lang.String objectId,
                             java.lang.String parentId,
                             java.lang.String redactionMode,
                             Redaction[] redactions,
                             java.lang.Boolean newVersion,
                             java.lang.Boolean majorVersion)

Saves the provided redactions, permanently modifying the provided document.

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the document to save redactions for.

parentId - The parentId of the document to save redactions for.

redactionMode - The mode under which, we're saving these redactions. Determines whether or not we keep an unredacted copy when saving redactions.

redactions - An array of redactions to save on the document.

newVersion - - true if the a new version of the document will be created when the document is redacted. if false, the document in the repository will remain the same version when redacted

majorVersion - - true if the a major version of the document will be created when the document is redacted. if false, the document in the repository will default to a minor version when redacted

Returns:

the RedactionInfo object that contains the list of failed redactions as well as the objectId of the redacted document

getRedactionSuggestions

java.util.List<RedactionSuggestion> getRedactionSuggestions(java.lang.String ticket,
                                                            java.lang.String objectId,
                                                            long lastModified,
                                                            int numPages)

Returns a list of suggested redactions and their locations which have been detected in the document. These redactions might include SSN, names, etc.

Parameters:

ticket - A valid OC ticket.

objectId - The objectId of the PDF object to create suggested redactions for.

lastModified - The timestamp this object was last modified (used for caching purposes).

numPages - number of pages in the document

Returns:

A list of RedactionSuggestion objects containing the page number, location, and reason for the redaction

redactTermsFromFolder

java.util.List<java.lang.String> redactTermsFromFolder(java.lang.String ticket,
                                                       java.lang.String containerId,
                                                       java.util.List<java.lang.String> stringsToRedact,
                                                       java.lang.String redactionMode,
                                                       java.lang.Boolean newVersion,
                                                       java.lang.Boolean majorVersion)

A method which will redact a list of terms from every document in a given folder.

Parameters:

ticket - - A valid OC ticket.

containerId - - The objectId of the folder that we will redact documents from.

stringsToRedact - - The string that will be redacted from the PDF documents contained in the folder

redactionMode - The mode under which, we're saving these redactions. Determines whether or not we keep an unredacted copy when saving redactions.

newVersion - - true if the a new version of the document will be created when the document is redacted. if false, the document in the repository will remain the same version when redacted

majorVersion - - true if the a major version of the document will be created when the document is redacted. if false, the document in the repository will default to a minor version when redacted

Returns:

A list of objectIds that refer to documents that failed to redact.

redactTermsFromDocument

com.aspose.pdf.Document redactTermsFromDocument(java.lang.String ticket,
                                                java.lang.String objectId,
                                                java.util.List<java.lang.String> stringToRedact)

Helper that finds a string of text in a PDF and redacts instances of that text

Parameters:

ticket - - a valid OC ticket

objectId - - the id of the document to be redacted

stringToRedact - - the list of strings that will be redacted from the PDF document

Returns:

the pdfDocument that has had the textToRedact string redacted

redactTermsFromListOfIds

java.util.List<java.lang.String> redactTermsFromListOfIds(java.lang.String ticket,
                                                          java.util.List<java.lang.String> objectIds,
                                                          java.util.List<java.lang.String> stringsToRedact,
                                                          java.lang.String redactionMode,
                                                          java.lang.Boolean newVersion,
                                                          java.lang.Boolean majorVersion)

A method which will redact a list of terms from every objectID passed in

Parameters:

ticket - - A valid OC ticket.

objectIds - - The objectIds selected that we will redact documents from.

stringsToRedact - - The list of strings that will be redacted from the PDF documents contained in the folder

redactionMode - The mode under which, we're saving these redactions. Determines whether or not we keep an unredacted copy when saving redactions.

newVersion - - true if the a new version of the document will be created when the document is redacted. if false, the document in the repository will remain the same version when redacted

majorVersion - - true if the a major version of the document will be created when the document is redacted. if false, the document in the repository will default to a minor version when redacted

Returns:

A list of objectIds that refer to documents that failed to redact.